Hanzo
OpenapiMarketing

Returns the caller org's OWN redemption of a promo — an org-scoped read, so it…

Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's.

GET /v1/marketing/promos/{code}/redemption

Addresshttps://api.hanzo.ai/v1/marketing/promos/{code}/redemption
MethodGET
Operationget_marketing_promos_by_code_redemption
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's. Not found when this org has not redeemed it.

Request

1 field.

FieldInTypeRequiredDescription
codepathstringyesCode is the promo code from the path, e.g.

Response

StatusBodyMeaning
200Redemptionok

200 body — 5 fields.

FieldInTypeAlwaysDescription
codebodystringCode is the promo redeemed.
discountCentsbodyintegerDiscountCents is the month-one discount this redemption CLAIMS, in USD cents. It is a recorded figure, NOT a balance: nothing was credited and no wallet moved.
planbodystringPlan is the tier redeemed against: pro, max or team.
redeemedAtbodyintegerRedeemedAt is unix seconds.
seatsbodyintegerSeats is the seat count the claim was priced at, and it is ALWAYS 1.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing promos redemption <code>

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page