        A reward is based on a scheme that an account has applied for in order to be
        eligible for a discount. Examples can include signup, promo, or partner codes that
        were applied to an account.

Fields

code : String

The referral code.

createdAt : DateTime

The datetime when the reward was created.

faqUrl : String

URL of the FAQ page for this referral scheme.

id : ID!


            required

maxRecurrence : Int

Max number of times this referral code can be credited to a given account.

paymentDate : Date

The date when the payment was made.

paymentStatus : ReferralStatusChoices

The status of the reward payment.

rewardAmount : Int

Reward amount given to the account in the smallest unit of the clients currency.

schemeType : ReferralSchemeTypeChoices

The type of reward scheme.

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.

Example

{
  "code": "stand-conference-future-heart-for",
  "createdAt": "2019-04-23T17:47:30.695798+00:00",
  "faqUrl": "want-mission-everyone-visit-create",
  "id": "32111544",
  "maxRecurrence": 69,
  "paymentDate": "1979-01-31",
  "paymentStatus": "Pending",
  "rewardAmount": 19,
  "schemeType": "REFERRAL_REWARD"
}