django-referral-system 0.3.1

A Django app for managing referral programs, promoters, referrals, and tracking referral performance with advanced features like commission setting, invitation management, and Wise payouts.

django-referral-system

A plug-and-play Django referral engine. Track promoters, reward commissions, manage payouts — all wired up in minutes.

Full documentation: Read the Docs

---

What it does

Area	Capability
Promoters	Create and manage promoters with unique referral tokens and links
Referral tracking	Track sign-ups, activation status, and click counts per link
Commissions	Configurable commission rates tied to the active referral program
Payouts	Wise CSV export; auto-skip promoters below minimum withdrawal balance
Refunds	Commission is automatically reversed when a referred user refunds
Email invitations	Send branded HTML invite emails via a custom template

Only one referral program can be active at a time, keeping the logic focused and predictable.

---

Quick start

1. Install

pip install django-referral-system

Requires Python 3.9 – 3.13 and Django 4.2+.

2. Add to INSTALLED_APPS

INSTALLED_APPS = [
    ...
    "referrals",
]

3. Mount the URLs

from django.urls import path, include

urlpatterns = [
    ...
    path("referrals/", include("referrals.urls")),
]

4. Migrate

python manage.py migrate

5. Create a referral program

python manage.py create_referral_program \
    --name="My Referral Program" \
    --commission-rate=5.00 \
    --min-withdrawal-balance=10.00

Setting a program as active automatically deactivates any existing active program.

---

Environment variables

Variable	Purpose
BASE_REFERRAL_LINK	Base URL used when generating referral links
BASE_EMAIL	Sender address for invitation emails

---

License

MIT — see LICENSE for details.

Contributing

Issues and pull requests are welcome. If this project saves you time, a star on GitHub goes a long way.