billing

GET /v1/billing/profile

Get the organization's billing profile.

Të gjitha pikat e skajshme billing

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen billing.view; një çelës pa të refuzohet me 403, jo 404.

Ku shkon id i organizatës suaj

Ky endpoint pranon org_id si parametër kërkimi. Lëreni bosh dhe thirrja do të mbulojë të gjithë nëndrurin tuaj të qiramarrjes; dërgojeni atë për ta ngushtuar thirrjen në një organizatë të vetme.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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

Parametrat

EmriLlojiKërkohetÇfarë është kjo
org_id (query)UuidJoThe organization whose profile to read; defaults to the caller's own.

Përgjigja

EmriLlojiKërkohetÇfarë është kjo
org_idstringPo
legal_namestringPo
company_namestringPo
billing_addressBillingAddressPoA 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_numberstringPo
vat_statusstring<unvalidated, pending, valid, invalid>PoState 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_idLabelValueJoA free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
custom_invoice_fieldsLabelValue[]PoUp to five customer-defined `{label, value}` lines, rendered verbatim.
billing_emailstringPoWhere invoices are delivered; blank means the account email.
invoice_localestringPoPreferred invoice language; blank means the account language.
updated_atstringJoWhen the profile was last saved. Null if it has never been saved.

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 422 · 429