billing

GET /v1/billing/profile

Get the organization's billing profile.

Vituo vyote vya billing

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya billing.view; ufunguo usio nayo unakataliwa kwa 403, si 404.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Kigezo hiki kinachukua org_id kama kigezo cha utafutaji. Iache wazi na simu itashughulikia tawi lako lote la wapangaji; itume ili kupunguza simu iwe ya shirika moja tu.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

JinaAinaInayohitajikaKilicho hiki
org_id (query)UuidHapanaThe organization whose profile to read; defaults to the caller's own.

Majibu

JinaAinaInayohitajikaKilicho hiki
org_idstringNdiyo
legal_namestringNdiyo
company_namestringNdiyo
billing_addressBillingAddressNdiyoA 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_numberstringNdiyo
vat_statusstring<unvalidated, pending, valid, invalid>NdiyoState 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_idLabelValueHapanaA free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
custom_invoice_fieldsLabelValue[]NdiyoUp to five customer-defined `{label, value}` lines, rendered verbatim.
billing_emailstringNdiyoWhere invoices are delivered; blank means the account email.
invoice_localestringNdiyoPreferred invoice language; blank means the account language.
updated_atstringHapanaWhen the profile was last saved. Null if it has never been saved.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 422 · 429