Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na billing.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Kung saan mapupunta ang id ng iyong organisasyon
Tinatanggap ng endpoint na ito ang org_id bilang parameter ng query. Huwag itong isama at saklaw ng tawag ang buong subtree ng iyong tenancy; ipadala ito para paliitin ang tawag sa isang organisasyon.
Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/billing/profile \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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`.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
org_id (query) | Uuid | Hindi | The organization whose profile to read; defaults to the caller's own. |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
org_id | string | Oo | — |
legal_name | string | Oo | — |
company_name | string | Oo | — |
billing_address | BillingAddress | Oo | 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 | Oo | — |
vat_status | string<unvalidated, pending, valid, invalid> | Oo | 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 | Hindi | A free-label secondary tax id (US EIN, AU ABN, …). Null when unset. |
custom_invoice_fields | LabelValue[] | Oo | Up to five customer-defined `{label, value}` lines, rendered verbatim. |
billing_email | string | Oo | Where invoices are delivered; blank means the account email. |
invoice_locale | string | Oo | Preferred invoice language; blank means the account language. |
updated_at | string | Hindi | When the profile was last saved. Null if it has never been saved. |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 422 · 429