Update a coupon

Update a coupon code.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The id of the coupon you're updating

Body Params
string

The name/code of the coupon.

float
Defaults to 25

The amount of the discount. A percentage when the parameter type is set to rate, a price when the parameter type is set to fixed

string
enum
Defaults to 0

Whether the coupon applies to upgrades or not. 0: does not apply to upgrades 1: applies to upgrades 2: only applies to upgrades

Allowed:
boolean
Defaults to true

To enable or disable the coupon

int32
Defaults to 0

The number of times that the coupon can be used. This is the total number of times per coupon, not the number of times per customer.

string
enum
Defaults to rate

The type of discount.

Allowed:
int32
Defaults to 0

The minimum items the cart should have before the coupon applies.

float
Defaults to 0

The minimum total amount the cart should have before the coupon applies.

boolean
Defaults to false

When set to true, further bulk discounts will stop processing for eligible items.

date-time

The moment the coupon should be active.

date-time

The moment the coupon should expire.

boolean
Defaults to false

When set to true, the endDate will be ignored.

conditions
object

Which stores, licenses, product types, or specific products the coupon applies to or not.

Responses

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