Create a coupon

Creates a new coupon.

Body Params
string

Optional alphanumeric coupon ID.

discount
object

Required discount object specifying the type and amount.

integer

The number of billing periods to which the discount can be applied.

boolean

Indicates whether the discount should be applied immediately. Limited availability.

boolean

Indicates whether the coupon discount should be combined with product discounts.

reason
object

Optional discount reason visible to customers. You can provide the discount reason in additional languages, including:

  • Arabic (ar)
  • Chinese (zh)
  • Croatian (hr)
  • Czech (cs)
  • Danish (da)
  • Dutch (nl)
  • English (en)
  • Finnish (fi)
  • French (fr)
  • German (de)
  • Hebrew (iw)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Russian (ru)
  • Slovak (sk)
  • Spanish (es)
  • Swedish (sv)
  • Turkish (tr)
integer

Optional limit for each coupon code.

available
object

Optional availability period for the coupon.

codes
array of strings

Optional array of coupon codes that trigger the discount.

codes
products
array of strings

Optional array of product IDs to which the discount applies.

products
boolean

Optional flag to indicate if the discount applies to external download services.

boolean

Optional flag to indicate if the discount applies to shipping fees.

Responses

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json