Update a coupon
Updates a coupon
Path parameters
Request body
Name of the coupon displayed to customers on for instance invoices or receipts.
Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
Date after which the coupon can no longer be redeemed
A set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.
Taking account of the above properties, whether this coupon can still be applied to a customer.
Example request
{
"maxRedemptions": 1
}Response
Coupon id
Organization id
Name of the coupon displayed to customers on for instance invoices or receipts.
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.
Fixed amount that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.
Name of the currency displayed to customers on for instance invoices or receipts.
Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
Date after which the coupon can no longer be redeemed
Taking account of the above properties, whether this coupon can still be applied to a customer.
Time at which this coupon was created.
A set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.
Whether the coupon is archived.
Date at which the coupon was archived
Number of times this coupon has been applied.
Example response
{
"percentOff": 1,
"maxRedemptions": 1,
"promotionCodes": [
{
"maxRedemptions": 1
}
],
"timesRedeemed": 1
}