Create a Referral
Creates a new referral under the specified affiliate program. Note: an Affiliate is required to create a Referral.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The affiliate ID associated with the referral
Name of the referred user
Email of the referred user
The external ID of the referred user
The plan associated with the referred user
Status of the referral (active/inactive)
Response
The referral ID
The affiliate ID associated with the referral
Name of the referred user
Email of the referred user
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)
The plan associated with the referred user
Status of the referral (active/inactive)