Sign in

v2

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

Apply coupon to customer

Apply a coupon to a specific customer, optionally linked to a subscription.

post/api/coupons/apply

Request body

couponIdstring required
customerIdstring required
subscriptionIdstring
usesRemainingnumber

Number of billing cycles to apply (null = forever)

Response

Coupon applied

idstring required
couponIdstring required
customerIdstring required
subscriptionIdstring
amountOffstring
usesRemainingnumber
createdAtstring required

Example response

{
  "amountOff": "20.0000",
  "usesRemaining": 3
}