extras
GET /v1/extra-purchases/{purchaseId}
Get an extra purchase.
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.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
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/extra-purchases/{purchaseId} \
-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 one extra purchase in scope with its status and outcome. Requires `billing.view`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
purchaseId (path) | Uuid | Oui | The extra purchase's id. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
extra_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | object | Non | — |
domain_id | object | Non | — |
status | ExtraPurchaseStatus | Oui | An extra purchase's lifecycle state. |
category | string | Oui | — |
fulfilment_type | ExtraFulfilmentType | Oui | How an extra is delivered. |
interval | ExtraInterval | Oui | One-off charge or a recurring subscription. |
price | MoneyAmount | Oui | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
recurrence | string<none, active, ended> | Oui | Whether the recurrence behind this purchase is still live. `none` = it never recurred (a one-off); `active` = a scheduled charge exists; `ended` = it recurred and no longer does… |
next_renewal_on | object | Non | The next charge date, or `null`. Also `null` for a live charge that has no date scheduled yet, so read `recurrence` — not this field — to decide whether a purchase renews at all. |
sla_due_at | object | Non | — |
completed_at | object | Non | — |
failure_reason | string | Non | — |
created_at | string | Oui | — |
updated_at | string | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429