AlmondTill/G3N API

ReferralPerformance

object type

How one referred business is performing for you: the roster row's fields VERBATIM (the ReferredSignup shape) plus what its months have earned you.

Fields

FieldTypeNotes
referredOrgGroupIdID ID!The referred org group (the business that signed up with your code).
referredGroupCodeStringThe referred group's code (its merchant handle). Null when the group no longer exists.
standingStringpending | approved | denied — derived from the referred group's own standing; null when the group no longer exists.
createdAtString String!When the referred group was born on your code (UTC ISO-8601).
decidedAtStringThe decision instant (UTC ISO-8601); null while pending.
cyclesEarnedInt Int!Line-1 months that paid you — one accrue entry each (the subscription share; LIFETIME while both groups stand).
latestCycleIntThe referred group's billed-cycle ordinal at its LAST line-1 mint (1-based). Null before the first mint.
usageMonthsEarnedInt Int!Line-2 months that paid you — one usage entry each (the consumption share inside the referred group's first 12 billed months; a month with no paid consumption mints nothing and still spends a window month).
usageMonthsLeftIntBilled months left in the usage window AS OF the last line-1 mint (12 − latestCycle, floored at 0). Null before the first mint.
earnedUsdCentsInt Int!What this business earned you, lifetime (accrue + usage; USD cents, ≥ 0).
clawbackUsdCentsInt Int!Dispute reversals traced to this business (USD cents, ≤ 0).
firstEarnedMonthStringThe first month (YYYY-MM) an earning entry landed for this business; null before the first.
lastEarnedMonthStringThe last month (YYYY-MM) an earning entry landed for this business; null before the first.