Sign in

v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
referrals

Redeem a referral code for a customer.

post/v1/referrals.redeem_code

Headers

x-api-versionstring required

Request body

codestring required

The referral code to redeem

customer_idstring required

The unique identifier of the customer redeeming the code

Example request

{
  "code": "REF123",
  "customer_id": "cus_456"
}

Response

OK

idstring required

The ID of the redemption event

customer_idstring required

Your unique identifier for the customer

reward_idstring required

The ID of the reward that will be granted

Example response

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