Update coupon

PUT

/v1/coupons/{code}

Update a coupon by code.

Parameters

Path Parameters

code

required

Code

string

Request Body ^required

CouponUpdate

object

name

Any of:

string

string

<= 255 characters

null

null

description

Any of:

string

string

null

null

expiration

Any of:

CouponExpiration

CouponExpiration

string

Allowed values: no_expiration time_limit

null

null

expiration_at

Any of:

string

string format: date-time

null

null

status

Any of:

CouponStatus

CouponStatus

string

Allowed values: active terminated

null

null

Responses

200

Successful Response

CouponResponse

object

id

required

Id

string format: uuid

code

required

Code

string

name

required

Name

string

description

Any of:

string

string

null

null

coupon_type

required

Coupon Type

string

amount_cents

Any of:

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

amount_currency

Any of:

string

string

null

null

percentage_rate

Any of:

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

frequency

required

Frequency

string

frequency_duration

Any of:

integer

integer

null

null

reusable

required

Reusable

boolean

expiration

required

Expiration

string

expiration_at

Any of:

string

string format: date-time

null

null

status

required

Status

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized

404

Coupon not found

422

Validation error