Referral Program API

A project's Referral Program turns members into affiliates: each gets a code and a link, a friend who arrives through them is counted for thirty days, and when that friend's first payment settles the affiliate earns what the programme promises, free membership days or a cash commission the creator pays out themselves. The programme, its affiliates, their referrals, the ledger of rewards and the payouts the creator records all live under /v1/projects/{project}.

The Referral Program is bundled with the Growth plan; Free and Starter accounts buy the Referral Program Addon. Every write is refused with 403 TEAM_TIER_REQUIRED when the creator is not entitled, and a programme on a lapsed account stops attributing and earning until the addon is bought again; what affiliates already earned stays, and the reads, the payouts and the ledger keep working so they can be paid.

A project holds one programme, addressed by the project alone. Rewards already written never change: each is priced when the payment settles, so editing the programme moves nothing in the ledger, and every approved or pending affiliate is told in their chat and by mail whenever the terms change, the programme is paused or it is switched back on.

EndpointsCopy Anchor Link

Related

Referral ProgramThe feature walkthrough.Referral Program AddonPricing and what it unlocks.referral.* eventsThe ten events; captures, conversions, rewards and reversals fire from members' own payments and the ledger, never from a call here.Coupons APIThe friend reward a programme can apply at a referred friend's checkout.Members APIThe ids an affiliate and a referral name.Ability ReferenceHow project-referral:* maps onto team roles.