extras

GET /v1/extra-purchases/{purchaseId}

Get an extra purchase.

Всички крайни точки в extras

Упълномощаване

Изпратете 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.

Отговор

ИмеТипЗадължителноКакво представлява
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Да

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 429