Authentication
Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/billing/profile \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the 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
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The organization whose profile to read; defaults to the caller's own. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | Yes | — |
legal_name | string | Yes | — |
company_name | string | Yes | — |
billing_address | BillingAddress | Yes | 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 | Yes | — |
vat_status | string<unvalidated, pending, valid, invalid> | Yes | 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 | No | A free-label secondary tax id (US EIN, AU ABN, …). Null when unset. |
custom_invoice_fields | LabelValue[] | Yes | Up to five customer-defined `{label, value}` lines, rendered verbatim. |
billing_email | string | Yes | Where invoices are delivered; blank means the account email. |
invoice_locale | string | Yes | Preferred invoice language; blank means the account language. |
updated_at | string | No | When the profile was last saved. Null if it has never been saved. |
Errors this endpoint can return
401 · 403 · 422 · 429