Skip to main content
GET
Get the caller's referral program page data

Authorizations

Authorization
string
header
required

JWT authentication token

Response

Referral program data

amounts
object
required

Server-computed reward amounts. USD is the credits' purchase value (credits x the top-up rate) and is the only dollar figure surfaced - the UI labels it "additional usage" and no longer shows credit counts. Computed server-side so the UI never does the math or hardcodes numbers.

Shareable sign-up link with the code embedded (ref=CODE); the code is never surfaced separately. Empty for the free program.

max_rewards
integer
required

Lifetime successful-referral cap (config-sourced), shown as X of N

program
enum<string>
required

Server-resolved from the caller's tag AND their live subscription state. free means not entitled - on the Free plan, never subscribed, or lapsed - and the UI renders the upgrade screen. A free response carries the amounts (the upgrade copy quotes them) with an empty link, zero stats and no rows; no referral code is minted for a caller who cannot be paid out.

Available options:
payg,
enterprise,
free
referrals
object[]
required
reward_hold_days
integer
required

Days after the referee's first payment before the referrer's reward is granted (config-sourced; the terms copy quotes it). The referee's own reward has no hold.

stats
object
required
leads
object[]

Enterprise program only: the caller's submitted sales leads (omitted/empty for PAYG)