Update coupon

Update an existing coupon.

Path Params
int32
required

Coupon ID.

Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string
required
length between 3 and 40

Display name of the coupon shown on invoices and receipts.

string
required
length between 3 and 255

Unique redemption code. Letters and numbers only.

date

Expiration date in YYYY-MM-DD format. Must be a future date. Set to null to remove expiration.

integer
≥ 1

Maximum number of times this coupon can be redeemed. Cannot be less than current redemption count.

plans
array of integers

Array of plan IDs this coupon is restricted to.

plans
metadata
object

Custom key-value metadata.

Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json