extras
GET /v1/extra-purchases/{purchaseId}
Get an extra purchase.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението billing.view; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/extra-purchases/{purchaseId} \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Returns one extra purchase in scope with its status and outcome. Requires billing.view.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
purchaseId (path) | Uuid | Да | The extra purchase's id. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
extra_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | object | Не | — |
domain_id | object | Не | — |
status | ExtraPurchaseStatus | Да | An extra purchase's lifecycle state. |
category | string | Да | — |
fulfilment_type | ExtraFulfilmentType | Да | How an extra is delivered. |
interval | ExtraInterval | Да | One-off charge or a recurring subscription. |
price | MoneyAmount | Да | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
recurrence | string<none, active, ended> | Да | 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 | Не | 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 | Не | — |
completed_at | object | Не | — |
failure_reason | string | Не | — |
created_at | string | Да | — |
updated_at | string | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 429