billing

GET /v1/billing/profile

Get the organization's billing profile.

所有 billing 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

您的组织 ID 应填在此处

此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。

您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X GET https://api.zinndigital.com/v1/billing/profile \
  -H "Authorization: Bearer zdk_live_…"

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

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`.

参数

名称类型必填内容简介
org_id (query)UuidThe organization whose profile to read; defaults to the caller's own.

响应

名称类型必填内容简介
org_idstring
legal_namestring
company_namestring
billing_addressBillingAddressA 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_numberstring
vat_statusstring<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_idLabelValueA free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
custom_invoice_fieldsLabelValue[]Up to five customer-defined `{label, value}` lines, rendered verbatim.
billing_emailstringWhere invoices are delivered; blank means the account email.
invoice_localestringPreferred invoice language; blank means the account language.
updated_atstringWhen the profile was last saved. Null if it has never been saved.

此端点可能返回的错误

401 · 403 · 422 · 429