billing

GET `/v1/billing/profile`

Get the organization's billing profile.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`org_id (query)`	`Uuid`	Non	The organization whose profile to read; defaults to the caller's own.

Réponse

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

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422 · 429