v2

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

Coupons

Delete a coupon

Delete or deactivate a coupon.

delete/api/coupons/{id}

Path parameters

idstring required

Coupon ID

Response

Coupon deleted or deactivated

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
}