billing

GET /v1/billing/profile

Get the organization's billing profile.

Svi billing krajnji točke

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu billing.view; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

Parametri

NazivVrstaObaveznoŠto je to
org_id (query)UuidNeThe organization whose profile to read; defaults to the caller's own.

Odgovor

NazivVrstaObaveznoŠto je to
org_idstringDa
legal_namestringDa
company_namestringDa
billing_addressBillingAddressDaA 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_numberstringDa
vat_statusstring<unvalidated, pending, valid, invalid>DaState 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_idLabelValueNeA free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
custom_invoice_fieldsLabelValue[]DaUp to five customer-defined `{label, value}` lines, rendered verbatim.
billing_emailstringDaWhere invoices are delivered; blank means the account email.
invoice_localestringDaPreferred invoice language; blank means the account language.
updated_atstringNeWhen the profile was last saved. Null if it has never been saved.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 422 · 429