Skip to main content
GET
Your invite link and referral progress

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Response

Invite code, link and progress.

code
string
required

Your invite code. A friend can type it in Settings › Plan.

url
string<uri>
required

Your invite link — the same code, as a page that signs them up.

earnedMonths
integer
required

Free months earned so far.

Required range: x >= 0
remainingMonths
integer
required

Free months still available to earn.

Required range: x >= 0
cap
integer
required

The most free months one person can earn, ever.

Required range: x >= 0
capped
boolean
required

True once earnedMonths reached cap. The link still gives friends their month.

pending
integer
required

Friends in their free month, or inside the 14 days after their first payment.

Required range: x >= 0