Update Coupon
The "Update Coupon" API enables you to modify existing coupon details such as discount values, validity periods, usage limits, and other promotional parameters. Use this endpoint to adjust or extend promotional offers for your customers.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
payments/ coupons. writeOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3Body
Location Id
BQdAwxa0ky1iK2sstLGJAlt Type
locationlocationCoupon Name
New Year SaleCoupon Code
LEVELUPDAY2022Discount Type
percentageamountamountDiscount Value
10Start date in YYYY-MM-DDTHH:mm:ssZ format
2023-01-01T22:45:00.000ZEnd date in YYYY-MM-DDTHH:mm:ssZ format
2023-01-31T22:45:00.000ZMax number of times coupon can be used
10Product Ids
["6241712be68f7a98102ba272"]Price Ids
["6241712be68f7a98102ba272"]Variant Ids
["6241712be68f7a98102ba272"]Is Coupon applicable on upcoming subscription transactions
truetrueIf coupon is applicable on upcoming subscription transactions, how many months should it be applicable for a subscription
{"type":"forever"}Limits whether a coupon can be redeemed only once per customer.
falsetrueCoupon Id
6241712be68f7a98102ba272Response
Successful response
Unique MongoDB identifier for the coupon
67f6c132d9485f9dacd5f123Number of times the coupon has been used
12Maximum number of times a customer can use this coupon (0 for unlimited)
5Location Id
79t07PzK8Tvf73d12312Type of entity
locationDisplay name of the coupon
NEWT6Redemption code for the coupon
NEWT6Type of discount (percentage or amount)
percentageamountpercentageValue of the discount (percentage or fixed amount)
25Current status of the coupon
scheduledactiveexpiredscheduledDate when the coupon becomes active
2025-04-30T18:30:00.000ZEnd date when the coupon expires
2025-05-30T18:30:00.000ZIndicates if the coupon applies to future recurring payments
trueConfiguration for how the coupon applies to future payments
User ID associated with the coupon (if applicable)
q0m15dTLGeiGOXG123123Creation timestamp
2025-04-09T18:49:22.026ZLast update timestamp
2025-04-09T18:49:22.026ZUnique identifier for tracing this API request
c667b18d-8f5e-44cf-a914