Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/billing/profile \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
Returns the customer's one "Bill to" block — what renders on the next invoice (docs/34 §2.5). An organization that has never saved one gets a **200 with an empty profile** (every field blank, `updated_at` null), not a 404, so the form always has a shape to render. Requires `billing.view`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
org_id (query) | Uuid | Nee | The organization whose profile to read; defaults to the caller's own. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
org_id | string | Ja | — |
legal_name | string | Ja | — |
company_name | string | Ja | — |
billing_address | BillingAddress | Ja | A billing address. Everything is optional **except** `country`, which tax determination needs (docs/34 §2.2). `country` is an ISO 3166-1 alpha-2 code, uppercased by the server. |
vat_number | string | Ja | — |
vat_status | string<unvalidated, pending, valid, invalid> | Ja | State of the validate-not-trust check on `vat_number` (docs/34 §2.3). Read-only; a change to `vat_number` resets it to `unvalidated`. |
tax_id | LabelValue | Nee | A free-label secondary tax id (US EIN, AU ABN, …). Null when unset. |
custom_invoice_fields | LabelValue[] | Ja | Up to five customer-defined `{label, value}` lines, rendered verbatim. |
billing_email | string | Ja | Where invoices are delivered; blank means the account email. |
invoice_locale | string | Ja | Preferred invoice language; blank means the account language. |
updated_at | string | Nee | When the profile was last saved. Null if it has never been saved. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 422 · 429