Update Referral
Updates a referral identified by referralId, and fires the referral.updated webhook.
Use subscriptionStatus to change whether a referral counts as active. Any field you send is applied directly to the referral, so sending a field that is not listed below will fail the request.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Fields to update
The referral to update
Name of the referred user
Email of the referred user. Lowercased before saving.
The ID you maintain for this user in your own system.
Plan the referred user is on
Status of the referral
ACTIVE, SUBMITTED, DECLINED Free-text notes on the referral
Arbitrary JSON to attach to the referral
Response
The updated referral.
The referral ID
The affiliate credited with this referral
The affiliate program this referral belongs to
The affiliate link the referral came through
The commission plan applied to this referral
Name of the referred user
Email of the referred user
The ID you maintain for this user in your own system — for example your database user ID or a Stripe customer ID.
Plan the referred user is on. Defaults to N/A when not supplied.
Status of the referral. Referrals created through this API are always ACTIVE.
ACTIVE, SUBMITTED, DECLINED Whether the referral was submitted by hand or captured automatically
MANUAL, AUTOMATIC How the referral was tracked
COUPON, LINK Where the referral came from. Referrals created through this API have API.
UNKNOWN, API, INTEGRATION, MANUAL, IMPORTED, AFFILIATE_SUBMITTED Total revenue attributed to this referral
Total commission generated by this referral
The first page the referred user landed on
Free-text notes on the referral
Arbitrary JSON you can attach to the referral
When the referral was created