billing

GET `/v1/billing/profile`

Get the organization's billing profile.

Autentifikatsiya

API kalitini bearer token sifatida yuboring. Kalit billing.view ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.

Tashkilotingiz identifikatori kiritiladigan joy

Bu soʻrovnoma oxiri org_id parametrini soʻrov parametri sifatida qabul qiladi. Uni kiritmasangiz, chaqiruv butun ijarachi quyi daraxtingizni qamrab oladi; uni bitta tashkilotga cheklash uchun yuboring.

Tashkilotingiz identifikatori boshqaruv panelingizdagi API kalitlari ekranida, kalitning o'z yonida joylashgan. Bu siz amalga oshiradigan har bir so'rovda bir xil identifikator hisoblanadi.

Sinab ko'rish

Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.

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

Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching

Tafsilotlar

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

Parametrlar

Nomi	Turi	Majburiy	Nima bu
`org_id (query)`	`Uuid`	Yo'q	The organization whose profile to read; defaults to the caller's own.

Javob

Nomi	Turi	Majburiy	Nima bu
`org_id`	`string`	Ha	—
`legal_name`	`string`	Ha	—
`company_name`	`string`	Ha	—
`billing_address`	`BillingAddress`	Ha	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`	Ha	—
`vat_status`	`string<unvalidated, pending, valid, invalid>`	Ha	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`	Yo'q	A free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
`custom_invoice_fields`	`LabelValue[]`	Ha	Up to five customer-defined `{label, value}` lines, rendered verbatim.
`billing_email`	`string`	Ha	Where invoices are delivered; blank means the account email.
`invoice_locale`	`string`	Ha	Preferred invoice language; blank means the account language.
`updated_at`	`string`	Yo'q	When the profile was last saved. Null if it has never been saved.

Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar

401 · 403 · 422 · 429