The code customers enter at checkout.
When the code stops working.
Required when type is ON_DATE.
Required when type is AFTER_DAYS.
Whether the code never expires, expires on a date, or after a number of days.
Must be STATIC (one shared checkout code). DYNAMIC unique-per-customer codes are not supported.
The commerce platform that should host this code.
How the discount reduces the order. Pass exactly one of amountOff, freeShipping, or buyXGetY.
A percent-off or amount-off discount.
Percent off (0–100) when valueType is PERCENTAGE; otherwise a currency amount.
Whether each customer may use the code only once.
Platform collection ids this code applies to.
Which other discounts this code may stack with.
Which customers may use the code.
Platform customer ids when eligibility is SPECIFIC.
Whether items already on sale are excluded.
A minimum purchase required to use the code.
Platform product ids this code applies to.
Whether the code applies to one-time, subscription, or both.
How many subscription cycles the code applies to.
Platform segment ids when eligibility is SEGMENTS.
Maximum times this code may be used in total.
Whether amount is a percent or a currency amount.
A buy-X-get-Y discount.
Whether each customer may use the code only once.
Which other discounts this code may stack with.
What the customer must buy to unlock the Y items.
Which customers may use the code.
What the customer gets, and at what discount.
Platform customer ids when eligibility is SPECIFIC.
Platform segment ids when eligibility is SEGMENTS.
Maximum times this code may be used in total.
How many times the Y items may be claimed on one order.
A free-shipping discount.
Whether each customer may use the code only once.
Which other discounts this code may stack with.
ISO country codes this free shipping applies to.
Which customers may use the code.
Platform customer ids when eligibility is SPECIFIC.
Shipping priced above this amount is not made free.
A minimum purchase required to use the code.
Whether the code applies to one-time, subscription, or both.
How many subscription cycles the code applies to.
Platform segment ids when eligibility is SEGMENTS.
Maximum times this code may be used in total.
The merchant-facing name of the discount.
