referrals

Your referral link, the companies that signed up with it, and the credit earned.

A company that signs up with your link has every payment in its first 30 days matched, up to $1,000 in total, and you get the same, payment by payment; its first payment of at least $10 gives each side at least $25. Then, for 12 months, you earn 10% of what it spends from credit it paid for, credited monthly. You earn at most $50,000 a calendar year, matches and share together. Money is integer microdollars in strings.

get/v1/referrals

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/referrals
  • Auth: HTTP bearer

Response

Success

codestring required

Your organization's referral code. Permanent.

linkstring required

Share this: https://withruntime.com/r/<code>.

rewardMicrosstring required

The least each side gets on the referred company's first qualifying payment: a smaller one is matched up to this. Integer microdollars, as a string.

maxRewardMicrosstring required

The most each side gets per referred company, all its matched payments together. Integer microdollars, as a string.

minPurchaseMicrosstring required

The smallest payment a referral matches. Integer microdollars, as a string.

yearlyCapMicrosstring required

The most referral credit, matches and share together, you can earn in one calendar year (UTC). Integer microdollars, as a string.

enabledboolean required

False while the program is paused.

yearinteger required
signedUpinteger required

Companies that signed up with your link.

pendinginteger required

Signed up, first qualifying payment not made yet.

paidinteger required

Referrals with a payment matched: both sides credited.

cappedinteger required

Paid, but the yearly cap left you less than a whole match.

reversedinteger required

Every matched payment was refunded or disputed below the minimum, so the matches were taken back.

earnedMicrosstring required

Referral credit you kept, all time: matches and share. Integer microdollars, as a string.

earnedThisYearMicrosstring required

Referral credit counted against this year's cap. Integer microdollars, as a string.

capRemainingMicrosstring required

What you can still earn this year. Integer microdollars, as a string.

payingCompaniesinteger required

Referred companies with a matched payment still standing.

shareEarnedMicrosstring required

Share credit you kept, all time: credited, less what lost disputes took back. Integer microdollars, as a string.

shareBasisPointsinteger required

Your share of what a referred company spends from credit it paid for, in basis points: 1000 is 10%.

shareMonthsinteger required

How long the share runs from a company's first matched payment.

windowDaysinteger required

How long after sign-up a referred company's payments are matched.

Changes

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