rewards

POST /v1/rewards.redeem

Redeem a reward promo code for a customer.

Request

Base URL
https://api.useautumn.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/useautumn/apis/autumn-api/docs/v1/rewards.redeem/post.ts
A function with typed inputs. Its response is checked against the schema.

x-api-versionstring required

codestring required

The reward promo code to redeem

customer_idstring required

The unique identifier of the customer redeeming the code

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

reward_idstring required

The ID of the redeemed reward

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

No recorded changes to this operation across all 1 revision of this API.