billing
PUT /v1/billing/profile
Replace the organization's billing profile.
Authentication
Send an API key as a bearer token. The key must carry the billing.invoice.manage 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 PUT https://api.zinndigital.com/v1/billing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "billing_address": <BillingAddress> }'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
A full replace (PUT) of the editable "Bill to" fields; an omitted field resets to blank. billing_address (with its required country, needed for tax) is the one mandatory member. Editing changes only invoices issued afterwards — a past invoice snapshotted the buyer block at issue time and is never rewritten (docs/34 §1.1). vat_status is engine-owned (the validate-not-trust flow, §2.3) and is not accepted here; changing vat_number resets it to unvalidated. Requires billing.invoice.manage in the target organization.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The organization whose profile to replace; defaults to the caller's own. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
legal_name | string | No | — |
company_name | string | No | — |
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 | No | — |
tax_id | LabelValue | No | — |
custom_invoice_fields | LabelValue[] | No | — |
billing_email | string | No | — |
invoice_locale | string | No | — |
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