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.

Possible Errors

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-7899: An internal error occurred.

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can create affiliate links
OR Can query affiliate links
OR Can update affiliate links

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

query ActiveAffiliateReferralScheme(
  $accountType: ReferralSchemeAccountTypeOptions,
  $subdomain: String!
) {
  activeAffiliateReferralScheme(
    accountType: $accountType,
    subdomain: $subdomain
  ) {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Variables

{
  "accountType": "DOMESTIC",
  "subdomain": "police-well-Mr-act-spring"
}

Response

{
  "data": {
    "activeAffiliateReferralScheme": {
      "canBeReferred": true,
      "code": "car-section-walk-big-air",
      "combinedRewardAmount": 56,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 77,
      "maxRecurrence": 87,
      "referralDisplayUrl": "institution-value-impact-paper-apply",
      "referralUrl": "likely-also-region-a-among",
      "referredRewardAmount": 15,
      "referrerGivenName": "Brenda",
      "referrerRewardAmount": 68,
      "schemeType": "meet-green-even-worker-training"
    }
  }
}