extras

GET /v1/extra-purchases/{purchaseId}

Get an extra purchase.

Все эндпоинты extras

Аутентификация

Отправьте ключ 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.

Ответ

ИмяТипОбязательноЧто это
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
extra_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idobjectНет
domain_idobjectНет
statusExtraPurchaseStatusДаAn extra purchase's lifecycle state.
categorystringДа
fulfilment_typeExtraFulfilmentTypeДаHow an extra is delivered.
intervalExtraIntervalДаOne-off charge or a recurring subscription.
priceMoneyAmountДаA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
recurrencestring<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_onobjectНет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_atobjectНет
completed_atobjectНет
failure_reasonstringНет
created_atstringДа
updated_atstringДа

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429