POST
/
referrals

Authorizations

Authorization
string
headerrequired

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

Body

application/json
affiliateId
string
required

The affiliate ID associated with the referral

name
string
required

Name of the referred user

email
string
required

Email of the referred user

referredUserExternalId
string
required

The external ID of the referred user

plan
string

The plan associated with the referred user

status
string

Status of the referral (active/inactive)

Response

200 - application/json
id
string

The referral ID

affiliateId
string

The affiliate ID associated with the referral

name
string

Name of the referred user

email
string

Email of the referred user

referredUserExternalId
string

The external ID of the referred user. This will be an ID you actively maintain that identifies the user on your server (for example, the User ID in your database, or Stripe Customer ID)

plan
string

The plan associated with the referred user

status
string

Status of the referral (active/inactive)