Demo docs: examples are illustrative.
Referral API

Introduction

Run a referral program for your SaaS without building one from scratch.

Referral API tracks who your customers bring in, calculates the rewards you owe, and keeps a clean record of every change. You connect your app once, then manage the program rules from the dashboard.

What Referral API does not do

Referral API calculates what you owe and records payouts, but you send the money yourself. It never moves funds, applies account credit, or changes subscriptions on your behalf.

How it fits together

Your app sends two kinds of events: signups and payments. Everything else, from attribution to the reward ledger, happens on our side.

Where to start

Explore by section

The tabs at the top of the sidebar switch between Guides, the REST API, realtime events, the reporting GraphQL API, and SDKs. Press ⌘ K to search everything.

How is this guide?