extras

GET /v1/extra-purchases/{purchaseId}

Get an extra purchase.

Alle extras-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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

Parameters

NaamTypeVerplichtWat dit is
purchaseId (path)UuidJaThe extra purchase's id.

Reactie

NaamTypeVerplichtWat dit is
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_idobjectNee
domain_idobjectNee
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_onobjectNeeThe 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_atobjectNee
completed_atobjectNee
failure_reasonstringNee
created_atstringJa
updated_atstringJa

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 429