Developer Docs

Apply a coupon to a payment

Applies a coupon to a pending payment before confirmation. The coupon system (one-time vs subscription) is auto-detected from the payment; applying a coupon of the wrong type returns an error. The payment amount is reduced so the discounted total is charged at confirmation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the payment to apply the coupon to

Body Params
string
required

Coupon code to apply to the payment

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json