Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Coupons

Create a coupon

Create a new discount coupon.

post/api/coupons

Request body

codestring required

Unique coupon code

namestring required

Display name

descriptionstring
discountType'PERCENTAGE' | 'FIXED_AMOUNT' required
discountValuenumber required

Discount value (percentage 0-100 or fixed amount)

currencystring

Currency for FIXED_AMOUNT discounts

maxRedemptionsnumber

Max number of redemptions (null = unlimited)

appliesToPlanIdsstring[]

Plan IDs this coupon applies to (empty = all)

expiresAtstring
createdAtstring

Backdate createdAt (ISO 8601). For data imports.

Example request

{
  "code": "WELCOME20",
  "name": "20% Welcome Discount",
  "discountValue": 20
}

Response

Coupon created

idstring required
codestring required
namestring required
descriptionstring
discountType'PERCENTAGE' | 'FIXED_AMOUNT' required
discountValuestring required

Discount value as decimal string

currencystring
maxRedemptionsnumber
redemptionCountnumber required
appliesToPlanIdsstring[] required
isActiveboolean required
expiresAtstring
createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "code": "SUMMER2026",
  "name": "Summer Sale",
  "description": "20% off all plans",
  "discountType": "PERCENTAGE",
  "discountValue": "20.0000",
  "currency": "USD",
  "maxRedemptions": 100,
  "redemptionCount": 5,
  "appliesToPlanIds": [
    "clxplan123"
  ],
  "isActive": true
}