Update an active coupon

put

https://v3.recurly.com/coupons/{coupon_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

coupon_id

string

required

Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.

Body Params

name

string

The internal name for the coupon.

max_redemptions

integer

A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.

max_redemptions_per_account

integer

Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to 1 if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.

hosted_description

string

This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.

invoice_description

string

length ≤ 255

Description of the coupon on the invoice.

redeem_by_date

string

The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.

Responses

200The updated coupon.

400Bad request, perhaps invalid JSON?

404Incorrect site or coupon ID.

422Invalid request parameters

defaultUnexpected error.