Get Coupons
Returns coupons for your program. A coupon defines the discount itself — how much comes off, in what currency, and for how long. The codes customers actually type at checkout are promotional codes, which each point at a coupon.
Filter with id, externalId or name for a single coupon. With no parameters, every coupon in the program is returned, newest first.
Each coupon comes back with its promotionalCodes (including the affiliate each is assigned to) and its autoCouponRule if one is configured.
Understanding Coupons
Coupons define the structure and rules for discounts in your affiliate program. They specify:- Discount type (percentage or flat amount)
- Discount value (e.g., 20% off or $10 off)
- Duration (one-time, forever, or repeating for X months)
- Restrictions (product limits, expiration dates, max redemptions)
Coupons vs Promotional Codes
- Coupon: The discount definition (e.g., “20% off for 3 months”)
- Promotional Code: The actual code string (e.g., “JOHN20”, “SAVE20”) that customers use
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The coupon's UUID. Returns a single coupon.
The coupon's ID in the connected billing provider, for example a Stripe coupon ID. Returns a single coupon.
The coupon's name. Returns a single coupon.
Response
A single coupon when filtering by id, externalId or name (null if no match), otherwise every coupon in the program.
- object
- object[]
A discount definition. Promotional codes point at a coupon for their value.
The coupon ID
Name of the coupon
The coupon's ID in the connected billing provider, for example a Stripe coupon ID
Whether the discount is a percentage or a fixed amount
PERCENTAGE, FLAT Percentage taken off, 1–100. Used when couponType is PERCENTAGE.
Fixed amount taken off. Used when couponType is FLAT.
Currency for amountOff, for example USD
How long the discount keeps applying to a subscription
once, forever, repeating Number of months the discount repeats for. Only set when duration is repeating.
Total redemptions allowed across every promotional code on this coupon. null means unlimited.
How many times this coupon has been redeemed so far
Whether the coupon discounts customers or is used to pay affiliates as a non-cash reward
CUSTOMER, PAYOUT Whether the coupon only applies to productIds
Products the coupon is restricted to
Collections the coupon is restricted to
Whether the coupon can currently be redeemed
Last date the coupon can be redeemed
The billing provider this coupon is synced with
NONE, STRIPE, CHARGEBEE, PADDLE, SHOPIFY, WOOCOMMERCE, ZYLVIE, POLAR The affiliate program this coupon belongs to
When the coupon was created
When the coupon was last updated
Promotional codes that point at this coupon
Rule used to generate codes automatically for affiliates, if configured