Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.rewards.get({
rewardId: "<id>",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.rewards.get(reward_id="<id>")curl --request POST \
--url https://api.useautumn.com/v1/rewards.get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"reward_id": "<string>"
}
'{
"coupon": {
"id": "summer_sale",
"name": "Summer Sale",
"type": "percentage_discount",
"value": 20,
"duration": {
"type": "months",
"length": 3
},
"plan_ids": [
"pro",
"starter"
],
"promo_codes": [
{
"code": "SUMMER20",
"global_max_redemption": 100,
"first_time_transaction": false
}
],
"created_at": 1718000000000
}
}
Rewards & Referrals
Get Reward
Fetch a coupon or feature grant by ID.
POST
/
v1
/
rewards.get
Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.rewards.get({
rewardId: "<id>",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.rewards.get(reward_id="<id>")curl --request POST \
--url https://api.useautumn.com/v1/rewards.get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"reward_id": "<string>"
}
'{
"coupon": {
"id": "summer_sale",
"name": "Summer Sale",
"type": "percentage_discount",
"value": 20,
"duration": {
"type": "months",
"length": 3
},
"plan_ids": [
"pro",
"starter"
],
"promo_codes": [
{
"code": "SUMMER20",
"global_max_redemption": 100,
"first_time_transaction": false
}
],
"created_at": 1718000000000
}
}
Body Parameters
Response
{
"coupon": {
"id": "summer_sale",
"name": "Summer Sale",
"type": "percentage_discount",
"value": 20,
"duration": {
"type": "months",
"length": 3
},
"plan_ids": [
"pro",
"starter"
],
"promo_codes": [
{
"code": "SUMMER20",
"global_max_redemption": 100,
"first_time_transaction": false
}
],
"created_at": 1718000000000
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
The ID of the coupon or feature grant.
Minimum string length:
1Response
200 - application/json
OK
Show child attributes
Show child attributes
Example:
{
"id": "summer_sale",
"name": "Summer Sale",
"type": "percentage_discount",
"value": 20,
"duration": { "type": "months", "length": 3 },
"plan_ids": ["pro", "starter"],
"promo_codes": [
{
"code": "SUMMER20",
"global_max_redemption": 100,
"first_time_transaction": false
}
],
"created_at": 1718000000000
}
Show child attributes
Show child attributes
Example:
{
"id": "beta_credits_grant",
"name": "Beta Tester Credits",
"promo_codes": [{ "code": "BETA2024", "max_uses": 500 }],
"grants": [
{
"feature_id": "credits",
"included": 1000,
"expiry": { "type": "month", "length": 1 }
}
],
"created_at": 1718000000000
}