Redeem Referral Code

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.referrals.redeemCode({
  code: "REF123",
  customerId: "cus_456",
});

from autumn_sdk import Autumn

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

res = autumn.referrals.redeem_code(
    code="REF123",
    customer_id="cus_456",
)

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

{
  "id": "<string>",
  "customer_id": "<string>",
  "reward_id": "<string>"
}

POST

referrals.redeem_code

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.referrals.redeemCode({
  code: "REF123",
  customerId: "cus_456",
});

from autumn_sdk import Autumn

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

res = autumn.referrals.redeem_code(
    code="REF123",
    customer_id="cus_456",
)

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

{
  "id": "<string>",
  "customer_id": "<string>",
  "reward_id": "<string>"
}

Body Parameters

Response

{
  "id": "<string>",
  "customer_id": "<string>",
  "reward_id": "<string>"
}

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

code

string

required

The referral code to redeem

customer_id

string

required

The unique identifier of the customer redeeming the code

Response

200 - application/json

string

required

The ID of the redemption event

customer_id

string

required

Your unique identifier for the customer

reward_id

string

required

The ID of the reward that will be granted

Create Referral Code List Rewards

⌘I

Billing

Balances

Customers

Authorization

Events

Entities

Plans

Features

Rewards & Referrals

Webhook Events

Platform (Beta)

Redeem Referral Code

Body Parameters

Response

Authorizations

Headers

Body

Response

​Body Parameters

​Response

Authorizations

Headers

Body

Response

Body Parameters

Response