Sign in
Discounts

Create a discount code

Creates a business-scoped discount code. The code is normalized to an uppercase, space-free value before saving.

post/v3/discount-codes

Request body

codestring required

Discount code. Saved uppercase with spaces removed.

applied_to'product_price' | 'shipping_cost' required
amount_type'fixed' | 'percentage' required
amountnumber nullable

Required when amount_type is fixed.

percentageinteger nullable

Required when amount_type is percentage.

is_max_amountboolean nullable

Required when amount_type is percentage.

max_amountnumber nullable
is_enabledboolean
is_usage_limitboolean
usage_limitinteger nullable
is_expiryboolean
expiry_timestring date-time nullable
is_limited_to_pagesboolean
page_idsinteger[]
is_limited_to_payment_methodsboolean
payment_methodsstring[]
is_minimum_revenueboolean
minimum_revenuenumber nullable

Example request

{
  "code": "SAVE10"
}

Response

Discount code

idinteger
business_idinteger
is_enabledboolean
codestring
applied_tostring nullable
amount_typestring nullable
is_max_amountboolean
is_usage_limitboolean
usage_limitinteger nullable
current_usageinteger nullable
is_expiryboolean
expiry_timestring date-time nullable
is_limited_to_pagesboolean
pagesobject[]
is_limited_to_payment_methodsboolean
payment_methodsstring[]
is_minimum_revenueboolean
inserted_atstring date-time nullable
updated_atstring date-time nullable

Changes