Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Referral details
Name of the referred user
Email of the referred user
The external ID of the referred user
The affiliate ID/Link associated with the referral (required if affiliateEmail and promoCode are not provided)
The affiliate email associated with the referral (required if affiliateId and promoCode are not provided)
The promotional code associated with an affiliate (required if affiliateId and affiliateEmail are not provided). When used, the promo code will be validated and its redemption count will be incremented.
The plan associated with the referred user
Status of the referral (active/inactive)
Response
Referral created successfully
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)