v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Coupons

Create coupon

Creates a new discount coupon with percentage or fixed amount off, applicable to customer subscriptions.

post/api/v1/coupons

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

idstring required

The unique identifier for the entity

namestring required

Name of the coupon

descriptionstring nullable required

Description of the coupon

percentOffnumber nullable required

Percentage discount off the original price

durationInMonthsinteger nullable required

Duration of the coupon validity in months

metadataobject nullable required

Metadata associated with the entity

Response

The newly created coupon object.