PUT
/
referrals

Authorizations

Authorization
string
header
required

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

Body

application/json
referralId
string
required

The referral ID to update

email
string

Email of the referred user

name
string

Name of the referred user

plan
string

The plan associated with 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)

status
string

Status of the referral (active/inactive)