Skip to main content
Referrals track businesses referred to Whop and the earnings generated from their processing volume. They help you see which referred businesses are active, how much volume they have processed, and what payouts are pending or completed. Use the Referrals API to list referred businesses, retrieve one referral, and review earnings across all referrals or for a single referred business.

​
Endpoints

EndpointRequest
List Business ReferralsGET /referrals/businesses
Retrieve Business ReferralGET /referrals/businesses/{id}
List Business Referral EarningsGET /referrals/businesses/{id}/earnings
List All Business Referral EarningsGET /referrals/businesses/earnings

​
Attributes

​
account
object | null
required
Referred account.

Properties

​
id
string
required
Referred account ID.
​
logo_url
string | null
required
Referred account logo URL.
​
route
string
required
Referred account route.
​
title
string
required
Referred account display name.
​
created_at
string
required
When the business referral was created.
​
earnings_usd
object
required

Properties

​
completed
string
required
Commission already paid out, in USD.
​
pending
string
required
Commission scheduled but not yet paid, in USD.
​
total
string
required
Pending + completed commission, in USD.
​
id
string
required
Business referral ID.
​
object
string
required
​
payout_percentage
number
required
Referrer’s share of Whop gross profit, as a fraction (0.3 = 30%).
​
referral_expires_at
string | null
required
When the referral expires.
​
referral_started_at
string | null
required
When the referral became active.
​
status
string
required
Current referral status.Available options: active, removed
​
volume_usd
object
required

Properties

​
attributed
string
required
Credited GMV (awaiting_settlement + settled); excludes canceled and reversed, in USD.
​
awaiting_settlement
string
required
GMV awaiting settlement (commission not yet computed), in USD.
​
settled
string
required
GMV of pending + completed payments, in USD.
BusinessReferral
{
	"account": {
		"id": "biz_xxxxxxxxxxxxxx",
		"logo_url": "https://cdn.whop.com/logo.png",
		"route": "pickaxe",
		"title": "Pickaxe"
	},
	"created_at": "2026-06-01T12:00:00Z",
	"earnings_usd": {
		"completed": "120.50",
		"pending": "45.25",
		"total": "165.75"
	},
	"id": "bref_xxxxxxxxxxxx",
	"object": "business_referral",
	"payout_percentage": 0.3,
	"referral_expires_at": "2027-06-01T12:00:00Z",
	"referral_started_at": "2026-06-01T12:00:00Z",
	"status": "active",
	"volume_usd": {
		"attributed": "11050.00",
		"awaiting_settlement": "250.00",
		"settled": "10800.00"
	}
}