Get account referrals

---

title: Get the referral program

Get the caller's referral program: their personal referral link and code to share, the rules, and the people they referred. Creates the link the first time it is called. Read-only as far as money goes: nothing is charged or credited by this call. A referred person gets a welcome bonus once their own paid top-ups add up to welcome_minimum (not on any first top-up), and the referrer gets a bonus once the referred person's own paid top-ups reach the goal, each once per referred person; the bonuses go to the stamp credit (see get_account_credit) and never count toward the minimum or the goal. Returns {referrals: on, rules: {welcome_bonus, welcome_minimum, goal, referrer_bonus, currency}, code, link (the referral link the caller shares; null with a message when it could not be created), welcome_bonus_pending (true when the caller was referred and their own welcome bonus is not credited yet), pending, awarded, earned (the referrer bonuses received so far), total, limit, offset, entries: [{email_masked, joined (ISO 8601 UTC), status (pending | awarded), amount (what was paid for an awarded one, what is promised for a pending one)}]} or {referrals: off}. The referred people's emails are masked, and how much they topped up is not available from this tool or any other. Error: referrals_unavailable.

Alcance (scope): invoices:read · Características: Idempotente

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
limit	integer	No
offset	integer	No
issuer	string	Sí	Id of the issuer the call acts for, from list_issuers.

Esquema de entrada (JSON Schema)

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 20
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "issuer": {
      "type": "string",
      "format": "uuid",
      "description": "Id of the issuer the call acts for, from list_issuers."
    }
  },
  "required": [
    "issuer"
  ]
}