billing

GET `/v1/billing/profile`

Get the organization's billing profile.

Doğrulama

API açarını bearer token kimi göndərin. Açar billing.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Təşkilatınızın identifikatorunun yerləşdiyi yer

Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.

Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`org_id (query)`	`Uuid`	Xeyr	The organization whose profile to read; defaults to the caller's own.

Cavab

Ad	Tip	Tələb olunur	Nədir
`org_id`	`string`	Bəli	—
`legal_name`	`string`	Bəli	—
`company_name`	`string`	Bəli	—
`billing_address`	`BillingAddress`	Bəli	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`	Bəli	—
`vat_status`	`string<unvalidated, pending, valid, invalid>`	Bəli	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`	Xeyr	A free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
`custom_invoice_fields`	`LabelValue[]`	Bəli	Up to five customer-defined `{label, value}` lines, rendered verbatim.
`billing_email`	`string`	Bəli	Where invoices are delivered; blank means the account email.
`invoice_locale`	`string`	Bəli	Preferred invoice language; blank means the account language.
`updated_at`	`string`	Xeyr	When the profile was last saved. Null if it has never been saved.

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 422 · 429