Create a coupon

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

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

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.

isEnable

boolean

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

promotionCodeData

object

required

The items to be used to create promotion code

200

500