extras
GET /v1/extra-purchases/{purchaseId}
Get an extra purchase.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/extra-purchases/{purchaseId} \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
Returns one extra purchase in scope with its status and outcome. Requires billing.view.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
purchaseId (path) | Uuid | Igen | The extra purchase's id. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
extra_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | object | Nem | — |
domain_id | object | Nem | — |
status | ExtraPurchaseStatus | Igen | An extra purchase's lifecycle state. |
category | string | Igen | — |
fulfilment_type | ExtraFulfilmentType | Igen | How an extra is delivered. |
interval | ExtraInterval | Igen | One-off charge or a recurring subscription. |
price | MoneyAmount | Igen | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
recurrence | string<none, active, ended> | Igen | 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 | Nem | 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 | Nem | — |
completed_at | object | Nem | — |
failure_reason | string | Nem | — |
created_at | string | Igen | — |
updated_at | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 429