Endpoints
| Endpoint | Request |
|---|---|
| List Referred Businesses | GET /partners/businesses |
| Retrieve a Referred Business | GET /partners/businesses/{id} |
| List Referred Business Earnings | GET /partners/businesses/{id}/earnings |
| Retrieve the Partner Leaderboard | GET /partners/leaderboard |
| List Referred Users | GET /partners/referred_users |
| Enroll as a Whop Partner | POST /partners |
Attributes
Partner business ID.
Referred account.
Properties
Properties
Referred account ID.
Properties
Properties
Bank payins: debits, transfers, and local bank railsAvailable options:
active, inactive, pendingBuy-now-pay-later payins; requires approvalAvailable options:
active, inactive, pendingCard payins, including Apple Pay and Google PayAvailable options:
active, inactive, pendingDeposits by bank wire or ACH to the account’s virtual bank accountAvailable options:
active, inactive, pendingBalance top-ups by charging a stored payment methodAvailable options:
active, inactive, pendingIssuing Whop cards; requires card application approvalAvailable options:
active, inactive, pendingOn-chain deposits to the account’s crypto walletAvailable options:
active, inactive, pendingOn-chain payouts to a crypto walletAvailable options:
active, inactive, pendingInstant payouts to an eligible payout destinationAvailable options:
active, inactive, pendingStandard payouts to an external payout destinationAvailable options:
active, inactive, pendingTransfers to other accountsAvailable options:
active, inactive, pendingReferred account logo URL.
Optional actions that unlock capabilities or grow the referred account.
Properties
Properties
The recommendation; new values may be added, so handle unknown actions gracefullyAvailable options:
theme_business, create_product, create_plan, verify_identity, connect_affiliate_program, create_promotion, setup_tracking_pixel, migrate_from_stripe, accept_first_payment, launch_first_ad, invite_team_member, enable_tax_collection, create_card, join_whop_university, apply_for_financingCapabilities this would unlock, or empty
The URL the call-to-action links to
Button label
Supporting copy, or empty
Illustration icon URL, or
nullEstimated impact from 0-100, or
null when not rankedWhy this action was recommended, or
nullAlways optional — never blockingAvailable options:
optionalHeadline for the recommendation
Actions the referred account owner must take to unblock capabilities.
Properties
Properties
What the holder must do; new values may be added, so handle unknown actions gracefullyAvailable options:
deposit_funds, submit_information_request, verify_identity, connect_fulfillment_trackerCapabilities gated until this is resolved
The URL the call-to-action links to, or null when there is no button
Button label, or empty when there is no button
Supporting copy, or empty
The URL of the action’s illustration icon, or null if it has none
required (act now) or pending (under review)Available options:
required, pendingHeadline for the action
Referred account route.
Referred account display name.
When the partner business was created.
The partner who referred the business owner onto Whop (first tier). Null if there is no active first-tier partner.
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, secondThe owner of the referred business.
Referrer’s share of Whop gross profit, as a fraction (0.3 = 30%). Second-tier
referrals earn a flat 0.1.
When the referral expires.
When the referral became active.
Current referral status.Available options:
active, removedPartnerBusiness