Coupons API
A coupon is one code many subscribers can redeem for money off at checkout: the multi-redemption counterpart to an access code, which is one code for one person and grants access outright without a payment.
A coupon is one code many subscribers can redeem for money off at checkout: the multi-redemption counterpart to an access code, which is one code for one person and grants access outright without a payment. Coupons live under a project at /v1/projects/{project}/coupons.
Coupons require the Coupons Addon, or a Growth plan. Every write is refused with 403 TEAM_TIER_REQUIRED if the creator is not entitled, and entitlement is re-checked again when a subscriber actually redeems.
Endpoints
GET
/v1/projects/{project}/couponsList a project's couponsPOST/v1/projects/{project}/couponsCreate a couponGET/v1/projects/{project}/coupons/{coupon}Get a couponPATCH/v1/projects/{project}/coupons/{coupon}Update a couponDELETE/v1/projects/{project}/coupons/{coupon}Delete a couponPOST/v1/projects/{project}/coupons/{coupon}/activateActivate a couponPOST/v1/projects/{project}/coupons/{coupon}/deactivateDeactivate a couponRelated
Coupon CodesThe feature walkthrough.Coupons AddonPricing, and which payment methods can discount.coupon.* eventsThe seven events; coupon.redeemed fires per checkout that settles with the code and coupon.exhausted when the last slot under the cap is taken, neither from a call here.Access Codes APIOne code, one person, grants access.Ability ReferenceHow project-coupon:* maps onto team roles.
How is this guide?
Last updated on