Credits

Read your referral link, what it pays, the writers you brought in and the credits earned.

The same read the Billing page's referral panel makes: signupUrl (the link to share, issued on first read), rewards (what each step pays you and the writer you bring on your track, the numbers the payout uses) and rewardSentence (the same as one sentence), totalReferees (writers brought in) and paidConversions, the credits earned (peerLifetimeCredits + mentorLifetimeCredits; a peer's quarter against peerQuarterlyCap), and recentEvents, each named in plain words (label, and voidLabel when it paid nothing). Read-only: nothing here pays or moves a credit. Scope: credits:read. Free.

get/referrals

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/referrals
  • Auth: HTTP bearer

Response

The referral program as the Billing page shows it.

codestring nullable required

The writer's referral code.

signupUrlstring nullable required

The link to share: a writer who signs up through it is theirs.

isMentorboolean required

True on the mentor track (uncapped); false on the peer track.

rewardSentencestring required

The rewards as the one sentence the Billing page shows.

peerLifetimeCreditsinteger required

Credits earned on the peer track, all time.

peerQuarterlyCreditsinteger required

Credits earned on the peer track this quarter.

peerQuarterlyCapinteger required

The most a peer earns in one quarter.

mentorLifetimeCreditsinteger required

Credits earned on the mentor track, all time.

totalRefereesinteger required

People brought in.

paidConversionsinteger required

Of those, how many upgraded to a paid plan.

Changes

No recorded changes to this operation across all 1 revision of this API.