Skip to article
Documentation menu

The ReferSprout guide

Make sharing worth their while.

The practical guide to customer referrals on your own Stripe billing. Start with a link. Add timely asks when you’re ready.

Give customers their link

Connect Stripe, choose a reward for each side, then decide where customers share. Verified free, trial and paid customers can refer.

Hosted page

No code. Customers verify their email and get their link on your referral page.

Use the hosted page →

Widget

A ready-made referral card inside your app, with a server-verified customer.

Embed the widget →

Server API

Your own experience, using the customer’s link, reward terms and progress.

Use the API →

Hosted referral page

Your page lives at /r/your-business. Customers use the email on their Stripe account; the sign-in link expires after 20 minutes. This access email is not a campaign or an automated ask email.

Set up the hosted page →

Embed a widget

Request a short-lived widget URL on your server after authenticating the customer. Embed it in your app, with clipboard access enabled. Keep your API key out of the browser.

Widget request and embed example →

Build with the server API

Enrol verified customers and read their own link and progress. Send configured moments for timely asks, then report real presentation and copy outcomes.

Enrolment request and response →
Moment and ask examples →
API errors and safe retries →

Customer participation

Deactivation stops new attribution, promotion-code redemptions and asks. It does not remove applied discounts, credits or obligations from existing referrals. Only explicit reactivation enables new participation.

Deactivate or reactivate a customer →
Why a percentage reward is waiting →

Understand programme access

Pausing asks leaves existing links and earned rewards alone. A billing pause stops enrolment and reward issuing. If a customer cannot join, check the response code before retrying.