Partner Program Referral Object

Example

{
  "email": "[email protected]",
  "referral_status": "confirmed",
  "rejection_reason": null,
  "payable": true,
  "country_code": "US",
  "cpa": 3.0,
  "utm_source": null,
  "utm_campaign": null,
  "referred_at": "2021-03-24T11:55:02.113Z",
  "confirmed_at": "2021-04-04T11:55:02.113Z",
  "rejected_at": null,
  "recommending_publication": {
    "uuid": "pub_18b5c17562ab",
    "name": "Butter In a Lordly Dish",
    "logo": "https://logo.url"
  }
}

Property	Type	Description
email	string	the email address of the referral
referral_status	string	the referral status of the subscriber. Possible values: confirmed, pending, rejected.
rejection_reason	string	the reason why the referral was rejected (only applied to rejected referrals).
payable	boolean	Whether or not the referral counts towards the payout.
country_code	string	The 2-letter country code the referral signed up from. For example: US, CA, IT
cpa	float	the referral's CPA (cost per acquisition)
utm_source	string	the acquisition source of the subscriber
utm_campaign	string	the acquistion campaign of the subscriber
referred_at	timestamp	the date the referral was created
confirmed_at	timestamp	the date the referral was confirmed (for confirmed referrals only)
rejected_at	timestamp	the date the referral was rejected (for rejected referrals only)
recommending_publication	object	an object with data about the partner who recommended the referral