Sign in

v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
rewards

Redeem a reward promo code for a customer.

post/v1/rewards.redeem

Headers

x-api-versionstring required

Request body

codestring required

The reward promo code to redeem

customer_idstring required

The unique identifier of the customer redeeming the code

Example request

{
  "code": "REWARD10",
  "customer_id": "cus_456"
}

Response

OK

reward_idstring required

The ID of the redeemed reward

Example response

{
  "reward_id": "reward_789",
  "entitlements_granted": [
    {
      "feature_id": "messages",
      "balance": 100
    }
  ]
}