Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.rewards.redeemCode({
code: "REWARD10",
customerId: "cus_456",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.rewards.redeem_code(
code="REWARD10",
customer_id="cus_456",
)curl --request POST \
--url https://api.useautumn.com/v1/rewards.redeem \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"code": "REWARD10",
"customer_id": "cus_456"
}
'{
"reward_id": "reward_789",
"entitlements_granted": [
{
"feature_id": "messages",
"balance": 100
}
]
}
Rewards & Referrals
Redeem Reward Code
Redeem a reward promo code for a customer.
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",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.rewards.redeem_code(
code="REWARD10",
customer_id="cus_456",
)curl --request POST \
--url https://api.useautumn.com/v1/rewards.redeem \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"code": "REWARD10",
"customer_id": "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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json