Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.rewards.create({
coupon: {
id: "summer_sale",
name: "Summer Sale",
duration: {
type: "months",
length: 3,
},
planIds: null,
promoCodes: [
{
code: "SUMMER20",
},
],
type: "percentage_discount",
value: 20,
},
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.rewards.create(
coupon={
"id": "summer_sale",
"name": "Summer Sale",
"duration": {
"type": "months",
"length": 3,
},
"plan_ids": None,
"promo_codes": [
{
"code": "SUMMER20",
},
],
"type": "percentage_discount",
"value": 20,
},
)curl --request POST \
--url https://api.useautumn.com/v1/rewards.create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"coupon": {
"id": "summer_sale",
"name": "Summer Sale",
"type": "percentage_discount",
"value": 20,
"duration": {
"type": "months",
"length": 3
},
"plan_ids": null,
"promo_codes": [
{
"code": "SUMMER20"
}
]
}
}
'{
"coupon": {
"id": "<string>",
"value": 123,
"duration": {
"length": 123
},
"plan_ids": [
"<string>"
],
"promo_codes": [
{
"code": "<string>",
"global_max_redemption": 123,
"first_time_transaction": true
}
],
"created_at": 123,
"name": "<string>"
},
"feature_grant": {
"id": "<string>",
"grants": [
{
"feature_id": "<string>",
"included": 123,
"expiry": {
"length": 0
}
}
],
"promo_codes": [
{
"code": "<string>",
"max_uses": 123
}
],
"created_at": 123,
"name": "<string>"
}
}Rewards & Referrals
Create Reward
Create a coupon or feature grant.
POST
/
v1
/
rewards.create
Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.rewards.create({
coupon: {
id: "summer_sale",
name: "Summer Sale",
duration: {
type: "months",
length: 3,
},
planIds: null,
promoCodes: [
{
code: "SUMMER20",
},
],
type: "percentage_discount",
value: 20,
},
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.rewards.create(
coupon={
"id": "summer_sale",
"name": "Summer Sale",
"duration": {
"type": "months",
"length": 3,
},
"plan_ids": None,
"promo_codes": [
{
"code": "SUMMER20",
},
],
"type": "percentage_discount",
"value": 20,
},
)curl --request POST \
--url https://api.useautumn.com/v1/rewards.create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"coupon": {
"id": "summer_sale",
"name": "Summer Sale",
"type": "percentage_discount",
"value": 20,
"duration": {
"type": "months",
"length": 3
},
"plan_ids": null,
"promo_codes": [
{
"code": "SUMMER20"
}
]
}
}
'{
"coupon": {
"id": "<string>",
"value": 123,
"duration": {
"length": 123
},
"plan_ids": [
"<string>"
],
"promo_codes": [
{
"code": "<string>",
"global_max_redemption": 123,
"first_time_transaction": true
}
],
"created_at": 123,
"name": "<string>"
},
"feature_grant": {
"id": "<string>",
"grants": [
{
"feature_id": "<string>",
"included": 123,
"expiry": {
"length": 0
}
}
],
"promo_codes": [
{
"code": "<string>",
"max_uses": 123
}
],
"created_at": 123,
"name": "<string>"
}
}Body Parameters
Response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Response
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
}
⌘I