Skip to main content
CouponsVersion: v3

Delete Coupon

DEL/payments/coupon

The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note that this action cannot be undone.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:payments/coupons.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Body

altIdstringrequired

Location Id

Example:BQdAwxa0ky1iK2sstLGJ
altTypestringrequired

Alt Type

Available optionslocation
Example:location
idstringrequired

Coupon Id

Example:6241712be68f7a98102ba272

Response

Successful response

successbooleanrequired

Indicates whether the delete was successful

Example:true
traceIdstringrequired

Unique identifier for tracing this API request

Example:c667b18d-8f5e-44cf-a914