Docs
Documentation
Everything you need to run a partner program on OpenPromoter Cloud or on your own server. New here? Start with Getting started.
First steps
Start here
- Start your first programStart your first affiliate program on OpenPromoter Cloud or your own server in about five minutes. Connect billing and accept the program design.
- Self-hosting with DockerSelf-host OpenPromoter on your server with Docker Compose and PostgreSQL 16. It has every feature with no limits under AGPL-3.0. See the steps.
Tracking and billing
- Tracking links and attributionHow OpenPromoter credits the right partner with op.js, partner links, short links, coupon codes and server-side attribution. Read the setup.
- Stripe setup and webhooksConnect Stripe with a restricted key or OAuth. See the webhook events OpenPromoter reads, how to test locally and how Connect pays partners.
- Billing provider integrationsConnect Paddle, Lemon Squeezy, Polar or Chargebee to OpenPromoter. Pass the click id as custom data and every sale goes to the right partner.
Program
- Commissions and payoutsHow the commission ledger works in OpenPromoter: hold periods, refunds and clawbacks, chargebacks, payout approval, payout rails and tax forms.
- Partner marketplaceList your affiliate program in the OpenPromoter partner marketplace so partners can find it, filter by category and commission type and apply in one click.
- AI features and providersWhat each AI feature does with Anthropic, OpenAI or a local model and what it does with no key. See the rules that keep AI away from your money.
- Embedded referral dashboardAdd a referral dashboard to your app with one script and one tag. Customers join your referral program and track what they earn inside your app.
Developers
- REST API reference and scopesThe OpenPromoter REST API v1: authentication with API keys and scopes, rate limits and every endpoint. Copy the requests and start building.
- Outgoing webhooks and alertsOpenPromoter webhooks: every outgoing event, the payload format, signature checks and retries with backoff. Plus Slack and Discord alerts.
- TypeScript SDK and helpersThe openpromoter npm package is a typed client for the OpenPromoter REST API. It adds helpers for signups, Stripe Checkout and webhook checks.
- MCP server for AI agentsConnect Claude, Cursor and other AI agents to your affiliate program with openpromoter-mcp. It is read-only by default and payouts need a person.
- Command-line tool (CLI)The openpromoter command-line tool for scripts and CI. It forwards webhook events to localhost for testing and installs the agent skill for you.
- Install with an AI agentPaste one prompt into Claude Code or Cursor and your coding agent adds OpenPromoter tracking to your app. It never touches your billing logic.