Enable a coupon

200

Response body

object

string

required

Coupon id

organizationId

string

required

Organization id

name

string

required

Name of the coupon displayed to customers on for instance invoices or receipts.

percentOff

number

0 to 100

Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.

amountOff

int64

≥ 0

Fixed amount that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.

currency

string

Name of the currency displayed to customers on for instance invoices or receipts.

maxRedemptions

number

Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.

redeemBy

date-time

Date after which the coupon can no longer be redeemed

isEnable

boolean

required

Taking account of the above properties, whether this coupon can still be applied to a customer.

createdAt

date-time

Time at which this coupon was created.

metadata

object

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.

Has additional fields

isArchived

boolean

required

Whether the coupon is archived.

archivedAt

date-time

Date at which the coupon was archived

promotionCodes

array of objects

required

promotionCodes*

object

string

required

Promotion code id

organizationId

string

required

Organization id

code

string

required

length between 2 and 20

The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.

couponId

string

required

Coupon id

isActive

boolean

required

Whether the promotion code is currently active. A promotion code is only active if the coupon is also enabled.

expiredAt

date-time

Date at which the promotion code can no longer be redeemed. If the coupon has specified a redeems_by, then this value cannot be after the coupon’s redeems_by.

maxRedemptions

number

Maximum number of times this promotion code can be redeemed. If the coupon has specified a max_redemptions, then this value cannot be greater than the coupon’s max_redemptions.

createdAt

date-time

Date at which the promotion code was created

metadata

object

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.

Has additional fields

status

string

required

The status of the coupon.

active expired disabled limit_reached

timesRedeemed

number

Number of times this coupon has been applied.

200

500