Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.referrals.listPrograms({});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.referrals.list_programs(
request={},
)curl --request POST \
--url https://api.useautumn.com/v1/referral_programs.list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '{}'{
"list": [
{
"id": "refer_a_friend",
"reward_id": "beta_credits_grant",
"redeem_on": "customer_creation",
"received_by": "referrer",
"max_redemptions": 10,
"plan_ids": null,
"exclude_trial": false,
"created_at": 1718000000000
}
]
}
Rewards & Referrals
List Referral Programs
List the referral programs configured for the org.
POST
/
v1
/
referral_programs.list
Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.referrals.listPrograms({});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.referrals.list_programs(
request={},
)curl --request POST \
--url https://api.useautumn.com/v1/referral_programs.list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '{}'{
"list": [
{
"id": "refer_a_friend",
"reward_id": "beta_credits_grant",
"redeem_on": "customer_creation",
"received_by": "referrer",
"max_redemptions": 10,
"plan_ids": null,
"exclude_trial": false,
"created_at": 1718000000000
}
]
}
Response
{
"list": [
{
"id": "refer_a_friend",
"reward_id": "beta_credits_grant",
"redeem_on": "customer_creation",
"received_by": "referrer",
"max_redemptions": 10,
"plan_ids": null,
"exclude_trial": false,
"created_at": 1718000000000
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
The body is of type ListReferralProgramsParams · object.
Response
200 - application/json
OK
Show child attributes
Show child attributes