ReferralSchemeType
A referral scheme is a way for one account to earn a reward for referring another. This is achieved by the referred account using a url (provided by the referring account) to sign up.
Fields
Whether the current account is eligible to be referred under this scheme.
The unique code for the scheme.
The reward amount received by the referrer and the referee combined.
True if the the scheme has limit of uses, and if the usage is at capacity.
The number of loyalty points to be awarded to the referrer in addition to the reward amount.
Max number of times this referral code can be credited to a given account.
A referral url for display purposes.
A fully qualified url give people to create accounts referred by this scheme.
The reward amount received by the referred party.
The family name of the person making the referral.
Only make use of the referrerGivenName for privacy reasons.
- Marked as deprecated on 2022-11-07.
- Scheduled for removal on or after 2023-01-07.
The given name of the person making the referral.
The reward amount received by the referrer.
Scheme type of the referral scheme.
Example
{
"canBeReferred": true,
"code": "floor-himself-oil-try-hundred",
"combinedRewardAmount": 98,
"isUsageAtCapacity": true,
"loyaltyPointsBonus": 83,
"maxRecurrence": 20,
"referralDisplayUrl": "soldier-air-hold-then-my",
"referralUrl": "north-effect-bag-present-field",
"referredRewardAmount": 2,
"referrerGivenName": "Austin",
"referrerRewardAmount": 8,
"schemeType": "modern-can-value-sit-it"
}