extras
GET /v1/extra-purchases/{purchaseId}
Get an extra purchase.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.view; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/extra-purchases/{purchaseId} \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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 | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 429