Create Referral Code

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.referrals.createCode({
  customerId: "cus_123",
  programId: "prog_123",
});

from autumn_sdk import Autumn

autumn = Autumn(secret_key="am_sk_test...")

res = autumn.referrals.create_code(
    customer_id="cus_123",
    program_id="prog_123",
)

curl --request POST \
  --url https://api.useautumn.com/v1/referrals.create_code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "customer_id": "cus_123",
  "program_id": "prog_123"
}
'

{
  "code": "<string>",
  "customer_id": "<string>",
  "created_at": 123
}

POST

referrals.create_code

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.referrals.createCode({
  customerId: "cus_123",
  programId: "prog_123",
});

from autumn_sdk import Autumn

autumn = Autumn(secret_key="am_sk_test...")

res = autumn.referrals.create_code(
    customer_id="cus_123",
    program_id="prog_123",
)

curl --request POST \
  --url https://api.useautumn.com/v1/referrals.create_code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "customer_id": "cus_123",
  "program_id": "prog_123"
}
'

{
  "code": "<string>",
  "customer_id": "<string>",
  "created_at": 123
}

Body Parameters

Response

{
  "code": "<string>",
  "customer_id": "<string>",
  "created_at": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version

string

default:2.3.0

required

Body

application/json

customer_id

string

required

The unique identifier of the customer

program_id

string

required

ID of your referral program

Response

200 - application/json

code

string

required

The referral code that can be shared with customers

customer_id

string

required

Your unique identifier for the customer

created_at

number

required

The timestamp of when the referral code was created

Delete Feature Redeem Referral Code

⌘I

Billing

Balances

Customers

Authorization

Events

Entities

Plans

Features

Rewards & Referrals

Webhook Events

Platform (Beta)

Create Referral Code

Body Parameters

Response

Authorizations

Headers

Body

Response

​Body Parameters

​Response

Authorizations

Headers

Body

Response

Body Parameters

Response