Skip to main content
POST
/
v1
/
rewards.redeem
Typescript (SDK)
import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.rewards.redeemCode({
  code: "REWARD10",
  customerId: "cus_456",
});
{
  "reward_id": "reward_789",
  "entitlements_granted": [
    {
      "feature_id": "messages",
      "balance": 100
    }
  ]
}

​
Body Parameters

​
Response

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-version
string
default:2.3.0
required

Body

application/json
​
code
string
required

The reward promo code to redeem

​
customer_id
string
required

The unique identifier of the customer redeeming the code

Response

200 - application/json

OK

​
reward_id
string
required

The ID of the redeemed reward

​
entitlements_granted
object[]
required

The feature balances granted to the customer