Skip to main content

Referrals

Here’s a full Referrals Documentation Page for your Peak SaaS boilerplate:

Referrals System

The Referrals system in Peak helps you incentivize user growth by rewarding users for inviting others to your platform. It’s built-in, easy to configure, and designed to boost viral growth with minimal setup.

Configuration​

You can configure all referral-related settings from the config/peak.php file:

'settings' => [
    'referrals' => [
        'reward' => 500, // Reward in cents (e.g., $5.00)
        'title' => 'Give a friend $50 and earn $25',
        'description' => "Each friend that signs up with your unique referral link will get <b>$50</b> in credit 30 days after signing up. Once they've spent <b>$25</b>, you'll get <b>$25</b>. There is no limit to the amount of credit you can earn through referrals.",
        'share_label' => "Share your link",
    ],
],

These settings let you customize the referral program messaging and reward logic directly from one file.

User Access​

Users can easily access their referral dashboard by navigating to:

Dashboard → Account Settings → Referrals

From here, users can:

  • View how many referrals they’ve made.
  • See how much reward credit they've earned.
  • Copy and share their unique referral link.

🛠 Admin Management​

Admins have powerful tools to manage and monitor the referral system.

  • Admin Panel → Referrals: View all referral activity across the platform.
  • Users → Individual User → Referral Tab: Review each user’s referral history and earned rewards.

This helps ensure transparency and gives administrators insights into how well the referral system is performing.

Disabling Referrals​

If you’d like to disable the referral system completely, you can do so by adding 'referrals' to the disabled_features array in config/peak.php:

'disabled_features' => [
    'referrals',
],

This will hide all user and admin-facing referral features throughout the application.

Summary​

  • Fully Configurable: Control rewards, labels, and referral copy from config/peak.php.
  • User Dashboard: Let users track and share their referral links with ease.
  • Admin Tools: Monitor and manage referrals from the admin panel.
  • Optional: Disable the feature entirely if it's not needed.

Need help customizing your referral logic? Reach out to support or check out our full documentation.

Let me know if you'd like a visual diagram or code examples to accompany this!