> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useautumn.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Referral Programs
> List the referral programs configured for the org.
export const DynamicResponseExample = ({json, statusCode = "200"}) => {
const toCamelCase = str => {
return str.replace(/_([a-z])/g, (_, c) => c.toUpperCase());
};
const convertKeysToCamelCase = obj => {
if (Array.isArray(obj)) {
return obj.map(item => convertKeysToCamelCase(item));
}
if (obj !== null && typeof obj === "object") {
return Object.keys(obj).reduce((acc, key) => {
const camelKey = toCamelCase(key);
acc[camelKey] = convertKeysToCamelCase(obj[key]);
return acc;
}, {});
}
return obj;
};
const [isTypeScript, setIsTypeScript] = useState(() => {
if (typeof window !== "undefined") {
try {
const lang = localStorage.getItem("code");
return JSON.parse(lang) === "typescript";
} catch {
return true;
}
}
return true;
});
useEffect(() => {
const onMintlifyStorage = event => {
if (event.detail?.key === "code") {
try {
const value = JSON.parse(event.detail.value);
setIsTypeScript(value === "typescript");
} catch {}
}
};
const pollInterval = setInterval(() => {
try {
const lang = localStorage.getItem("code");
const value = JSON.parse(lang);
setIsTypeScript(value === "typescript");
} catch {}
}, 300);
document.addEventListener("mintlify-localstorage", onMintlifyStorage);
return () => {
document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
clearInterval(pollInterval);
};
}, []);
const camelCaseJson = useMemo(() => convertKeysToCamelCase(json), [json]);
const snakeCaseString = JSON.stringify(json, null, 2);
const camelCaseString = JSON.stringify(camelCaseJson, null, 2);
return
{isTypeScript ?
{camelCaseString}
:
{snakeCaseString}
}
;
};
export const DynamicResponseField = ({children, name, ...props}) => {
const convertToCamelCase = str => {
if (typeof str !== "string") return str;
return str.replace(/[_-](\w)/g, (_, c) => c.toUpperCase());
};
const [lang, setLang] = useState(() => {
if (typeof window !== "undefined") {
const stored = localStorage.getItem("code");
return stored || '"typescript"';
}
return '"typescript"';
});
useEffect(() => {
const onMintlifyStorage = event => {
const key = event.detail?.key;
if (key === "code") {
setLang(event.detail.value);
}
};
const pollInterval = setInterval(() => {
const current = localStorage.getItem("code");
if (current && current !== lang) {
setLang(current);
}
}, 500);
document.addEventListener("mintlify-localstorage", onMintlifyStorage);
return () => {
document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
clearInterval(pollInterval);
};
}, [lang]);
const resolvedName = useMemo(() => {
try {
const value = JSON.parse(lang);
const useCamelCase = value === "typescript";
return useCamelCase ? convertToCamelCase(name) : name;
} catch {
return name;
}
}, [name, lang]);
return
{children}
;
};
export const DynamicParamField = ({children, body, path, ...props}) => {
const convertToCamelCase = str => {
if (typeof str !== "string") return str;
return str.replace(/[_-](\w)/g, (_, c) => c.toUpperCase());
};
const [lang, setLang] = useState(() => {
if (typeof window !== "undefined") {
const stored = localStorage.getItem("code");
return stored || '"typescript"';
}
return '"typescript"';
});
useEffect(() => {
const onMintlifyStorage = event => {
const key = event.detail?.key;
if (key === "code") {
setLang(event.detail.value);
}
};
const pollInterval = setInterval(() => {
const current = localStorage.getItem("code");
if (current && current !== lang) {
setLang(current);
}
}, 500);
document.addEventListener("mintlify-localstorage", onMintlifyStorage);
return () => {
document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
clearInterval(pollInterval);
};
}, [lang]);
const resolvedBody = useMemo(() => {
try {
const value = JSON.parse(lang);
const useCamelCase = value === "typescript";
return useCamelCase ? convertToCamelCase(body) : body;
} catch {
return body;
}
}, [body, lang]);
const resolvedPath = useMemo(() => {
try {
const value = JSON.parse(lang);
const useCamelCase = value === "typescript";
return useCamelCase ? convertToCamelCase(path) : path;
} catch {
return path;
}
}, [path, lang]);
return
{children}
;
};
### Response
The unique identifier for the referral program.
The ID of the reward granted when a code is redeemed.
When the reward is granted: on redemption, or when the redeemer checks out.
Who receives the reward: the referrer only, or both parties.
The maximum number of times a referral code can be redeemed.
The plans whose checkout triggers the reward. Only used when redeem\_on is checkout.
Whether checkouts that start a trial should skip granting the reward.
The Unix timestamp (in milliseconds) when the referral program was created.
```json 200 theme={null}
{
"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
}
]
}
```
## OpenAPI
````yaml openapi POST /v1/referral_programs.list
openapi: 3.1.0
info:
title: Autumn API
version: 2.3.0
servers:
- url: https://api.useautumn.com
description: Production server
security:
- secretKey: []
paths:
/v1/referral_programs.list:
post:
tags:
- referrals
description: List the referral programs configured for the org.
operationId: listReferralPrograms
parameters:
- name: x-api-version
in: header
required: true
schema:
type: string
default: 2.3.0
x-speakeasy-globals-hidden: true
requestBody:
required: false
content:
application/json:
schema:
type: object
title: ListReferralProgramsParams
examples:
- {}
example: {}
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
list:
type: array
items:
type: object
properties:
id:
type: string
description: The unique identifier for the referral program.
reward_id:
type: string
description: >-
The ID of the reward granted when a code is
redeemed.
redeem_on:
enum:
- customer_creation
- checkout
type: string
description: >-
When the reward is granted: on redemption, or when
the redeemer checks out.
received_by:
enum:
- referrer
- all
type: string
description: >-
Who receives the reward: the referrer only, or both
parties.
max_redemptions:
anyOf:
- type: number
- type: 'null'
description: >-
The maximum number of times a referral code can be
redeemed.
plan_ids:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: >-
The plans whose checkout triggers the reward. Only
used when redeem_on is checkout.
exclude_trial:
anyOf:
- type: boolean
- type: 'null'
description: >-
Whether checkouts that start a trial should skip
granting the reward.
created_at:
type: number
description: >-
The Unix timestamp (in milliseconds) when the
referral program was created.
required:
- id
- reward_id
- redeem_on
- received_by
- created_at
examples:
- 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
required:
- list
title: ListReferralProgramsResponse
examples:
- 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
example:
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
x-codeSamples:
- lang: typescript
label: Typescript (SDK)
source: |-
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.referrals.listPrograms({});
- lang: python
label: Python (SDK)
source: |-
from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.referrals.list_programs(
request={},
)
components:
securitySchemes:
secretKey:
type: http
scheme: bearer
bearerFormat: JWT
````