extras

GET /v1/extra-purchases/{purchaseId}

Get an extra purchase.

Alle extras Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/extra-purchases/{purchaseId} \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Returns one extra purchase in scope with its status and outcome. Requires `billing.view`.

Parameter

NameTypErforderlichWas es ist
purchaseId (path)UuidJaThe extra purchase's id.

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
extra_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idobjectNein
domain_idobjectNein
statusExtraPurchaseStatusJaAn extra purchase's lifecycle state.
categorystringJa
fulfilment_typeExtraFulfilmentTypeJaHow an extra is delivered.
intervalExtraIntervalJaOne-off charge or a recurring subscription.
priceMoneyAmountJaA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
recurrencestring<none, active, ended>JaWhether 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_onobjectNeinThe 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_atobjectNein
completed_atobjectNein
failure_reasonstringNein
created_atstringJa
updated_atstringJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429