Redeem a Coupon Code

Mark a coupon code as redeemed. Once redeemed, the code is invalidated and removed from the member's available coupons.

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

This endpoint is used to mark a coupon code as redeemed, typically called by the Point of Sale (POS) system. It informs the system that the coupon code has already been applied to the receipt, ensuring that it can be removed from the loyalty platform.

📘

Stock Management

If the coupon code has stock management enabled, one use will be subtracted from the available stock for that coupon.

📘

Multiple Members

If the coupon code is assigned to multiple members, all associated codes will be marked as redeemed.

🚧

Recommendation

We strongly suggest using this endpoint only if you are working with unique coupon codes to prevent unintended bulk redemptions.

Path Params
string
required

Coupon code you want to redeem

Body Params
string
enum
Defaults to CustomParam

Type of provided Venue ID

Allowed:
string
Defaults to OurID:V001

For custom param use param_slug:custom_param_value

json
Defaults to {}

Custom parameters

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

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