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. writeAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Body
altIdstringrequired
Location Id
Example:
BQdAwxa0ky1iK2sstLGJaltTypestringrequired
Alt Type
Available options
locationExample:
locationidstringrequired
Coupon Id
Example:
6241712be68f7a98102ba272Response
Successful response
successbooleanrequired
Indicates whether the delete was successful
Example:
truetraceIdstringrequired
Unique identifier for tracing this API request
Example:
c667b18d-8f5e-44cf-a914