Hanzo
OpenapiMarketing

Returns every promo the deployment offers with its live counters: how many orgs…

Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap.

GET /v1/marketing/promos

Addresshttps://api.hanzo.ai/v1/marketing/promos
MethodGET
Operationget_marketing_promos
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap. The promos are fleet-wide, not per-org — only the counters move.

Request

GET /v1/marketing/promos takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200PromoListok

200 body — 12 fields.

FieldInTypeAlwaysDescription
databodyPromoStatus[]Data is every promo in the deployment, oldest first, each with its live counters. The list is fleet-wide rather than per-org.
data[].promobodyPromo
data[].promo.activebodybooleanActive is false for a promo that is no longer offered; an inactive promo quotes as ineligible and refuses to redeem.
data[].promo.codebodystringCode is the promo id, e.g.
data[].promo.createdAtbodyintegerCreatedAt is unix seconds.
data[].promo.descriptionbodystringDescription is the human-readable offer.
data[].promo.maxRedemptionsbodyintegerMaxRedemptions is the hard fleet-wide cap; the redemption past it is declined.
data[].promo.percentOffbodyintegerPercentOff is the discount applied to ONE month's list price.
data[].promo.plansbodystringPlans is the csv of eligible plan ids ("pro,max,team").
data[].promo.teamSeatCapbodyintegerTeamSeatCap is how many Team seats bill at the promo rate; seats beyond it bill at list.
data[].redeemedbodyintegerRedeemed is how many orgs have taken it, Remaining how many are left under the fleet-wide cap.
data[].remainingbodyintegerRemaining is MaxRedemptions minus Redeemed, floored at 0.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing promos list

Marketing API · All Hanzo APIs · Interactive reference

How is this guide?

On this page