Affiliates earn commissions for referred sales. The API flow has two parts: create an affiliate record, then add overrides that define the commission.Documentation Index
Fetch the complete documentation index at: https://docs.whop.com/llms.txt
Use this file to discover all available pages before exploring further.
How attribution works
- You create an affiliate record for a user, then add overrides. Each override returns
product_direct_linkandcheckout_direct_linkfields. These are referral URLs the affiliate shares (they include?a=<username>). - A buyer clicks the link; Whop stores the affiliate cookie (30-day attribution window by default).
- Buyer checks out within the window. Commission is calculated per the matching override:
standard(per-plan, percentage or flat fee) orrev_share(percentage of revenue, product-specific or company-wide). - Commission is attributed to the affiliate and reflected in the override’s
total_referral_earnings_usdfield.
Refunds reverse commissions. If a buyer refunds within the window, the affiliate’s earning on that sale is clawed back automatically.
Affiliates need a Whop company to receive payouts. Earnings accrue on the record; payouts go to their company balance via transfers. If they do not have a company yet, onboard them with connected account enrollment.
Create an affiliate
user_identifier resolves flexibly. Pass a username, email, user ID, or Discord ID. If an affiliate record already exists for the company + user pair, the existing record is returned (idempotent).
Add commission overrides
An affiliate record does not set a commission by itself. Add overrides to decide what the affiliate gets paid.| Override type | What it does | Required fields |
|---|---|---|
standard | Per-plan commission, percentage or flat fee | plan_id, commission_type, commission_value, applies_to_payments |
rev_share | Percentage revenue share, product-specific or company-wide | commission_value (always percentage); product_id optional |
Standard (per-plan)
commission_value rules:
"percentage": whole number 1–100 (40= 40%)."flat_fee": dollar amount (10= $10).
applies_to_payments:
"first_payment": affiliate earns only on the initial purchase."all_payments": affiliate earns on every recurring payment too.
Rev-share (revenue percentage)
Rev-share overrides are always percentage-based. Don’t passcommission_type: "flat_fee".
Manage overrides
Manage affiliates
Company-level affiliate settings
Three company fields control how the affiliate program is presented to users. Update them via the Company resource.| Field | Description |
|---|---|
affiliate_instructions | Guidelines shown to affiliates promoting this company |
affiliate_application_required | Whether users must apply and be approved before becoming affiliates |
featured_affiliate_product_id | Which product to feature for affiliate promotion |
Tracking earnings
Each override includes atotal_referral_earnings_usd field that reflects cumulative earnings (in USD) for that specific override. Re-fetch the override (or list overrides on an affiliate) to get the current total.
There is no dedicated
affiliate.* webhook in v1, and the public payment schema does not expose affiliate linkage. Poll listOverrides on your payout schedule and compare the latest total_referral_earnings_usd values with the last values you stored.Override response fields
| Field | Description |
|---|---|
override_type | "standard" or "rev_share" |
commission_type | "percentage" or "flat_fee" |
commission_value | Percentage (1–100) or flat fee in dollars |
applies_to_payments | "first_payment" or "all_payments" (standard only; null for rev-share) |
plan_id | Plan ID (standard only) |
product_id | Product ID (rev-share only; null if company-wide) |
applies_to_products | "single_product" or "all_products" (rev-share only) |
product_direct_link | Referral link to product page (standard only) |
checkout_direct_link | Referral link to checkout page (standard only) |
total_referral_earnings_usd | Cumulative earnings for this override |
Next steps
Pay out affiliate earnings
Transfer accrued commissions from your balance to affiliate companies.
Accept payments
Checkout configurations attribute sales automatically when referral cookies are set.
Listen to webhooks
Use
payment.succeeded for general sales telemetry; affiliate attribution still polls.Affiliates API reference
Full resource. Endpoints, fields, and override schemas.

