extras

GET /v1/extra-purchases/{purchaseId}

Get an extra purchase.

Minden extras végpont

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évTípusKötelezőMi ez
purchaseId (path)UuidIgenThe extra purchase's id.

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
extra_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idobjectNem
domain_idobjectNem
statusExtraPurchaseStatusIgenAn extra purchase's lifecycle state.
categorystringIgen
fulfilment_typeExtraFulfilmentTypeIgenHow an extra is delivered.
intervalExtraIntervalIgenOne-off charge or a recurring subscription.
priceMoneyAmountIgenA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
recurrencestring<none, active, ended>IgenWhether 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_onobjectNemThe 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_atobjectNem
completed_atobjectNem
failure_reasonstringNem
created_atstringIgen
updated_atstringIgen

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429