Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.view; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/extra-purchases/{purchaseId} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
Returns one extra purchase in scope with its status and outcome. Requires `billing.view`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
purchaseId (path) | Uuid | Sim | The extra purchase's id. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
extra_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | object | Não | — |
domain_id | object | Não | — |
status | ExtraPurchaseStatus | Sim | An extra purchase's lifecycle state. |
category | string | Sim | — |
fulfilment_type | ExtraFulfilmentType | Sim | How an extra is delivered. |
interval | ExtraInterval | Sim | One-off charge or a recurring subscription. |
price | MoneyAmount | Sim | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
recurrence | string<none, active, ended> | Sim | 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 | Não | 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 | Não | — |
completed_at | object | Não | — |
failure_reason | string | Não | — |
created_at | string | Sim | — |
updated_at | string | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429