Skip to main content
GET
Retrieve a referred business

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-08-1"

Path Parameters

id
string
required

The partner business ID (a coma_ identifier).

Response

partner business retrieved

account
object | null
required

Referred account.

created_at
string<date-time>
required

When the partner business was created.

earnings_usd
object
required
first_tier_partner
object | null
required

The partner who referred the business owner onto Whop (first tier). Null if there is no active first-tier partner.

id
string
required

Partner business ID.

my_partner_tier
enum<string>
required

Which tier the caller earns on for this business: first (they referred the owner) or second (they referred the first-tier partner).

Available options:
first,
second
object
enum<string>
required
Available options:
partner_business
owner
object | null
required

The owner of the referred business.

payout_percentage
number<float>
required

Referrer's share of Whop gross profit, as a fraction (0.3 = 30%). Second-tier referrals earn a flat 0.1.

referral_expires_at
string<date-time> | null
required

When the referral expires.

referral_started_at
string<date-time> | null
required

When the referral became active.

status
enum<string>
required

Current referral status.

Available options:
active,
removed
volume_usd
object
required