身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.invoice.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X PUT https://api.zinndigital.com/v1/billing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "billing_address": <BillingAddress> }'已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id (query) | Uuid | 否 | The organization whose profile to replace; defaults to the caller's own. |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
legal_name | string | 否 | — |
company_name | string | 否 | — |
billing_address | BillingAddress | 是 | 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 | 否 | — |
tax_id | LabelValue | 否 | — |
custom_invoice_fields | LabelValue[] | 否 | — |
billing_email | string | 否 | — |
invoice_locale | string | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id | string | 是 | — |
legal_name | string | 是 | — |
company_name | string | 是 | — |
billing_address | BillingAddress | 是 | 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 | 是 | — |
vat_status | string<unvalidated, pending, valid, invalid> | 是 | 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 | 否 | A free-label secondary tax id (US EIN, AU ABN, …). Null when unset. |
custom_invoice_fields | LabelValue[] | 是 | Up to five customer-defined `{label, value}` lines, rendered verbatim. |
billing_email | string | 是 | Where invoices are delivered; blank means the account email. |
invoice_locale | string | 是 | Preferred invoice language; blank means the account language. |
updated_at | string | 否 | When the profile was last saved. Null if it has never been saved. |
此端点可能返回的错误
401 · 403 · 422 · 429