Endpoints
Attributes
string
required
Partner business ID.
object | null
required
Referred account.
Properties
Properties
string
required
Referred account ID.
object | null
required
Properties
Properties
string
required
Bank payins: debits, transfers, and local bank railsAvailable options:
active, inactive, pendingstring
required
Buy-now-pay-later payins; requires approvalAvailable options:
active, inactive, pendingstring
required
Card payins, including Apple Pay and Google PayAvailable options:
active, inactive, pendingstring
required
Deposits by bank wire or ACH to the account’s virtual bank accountAvailable options:
active, inactive, pendingstring
required
Balance top-ups by charging a stored payment methodAvailable options:
active, inactive, pendingstring
required
Issuing Whop cards; requires card application approvalAvailable options:
active, inactive, pendingstring
required
On-chain deposits to the account’s crypto walletAvailable options:
active, inactive, pendingstring
required
On-chain payouts to a crypto walletAvailable options:
active, inactive, pendingstring
required
Instant payouts to an eligible payout destinationAvailable options:
active, inactive, pendingstring
required
Launching ad campaigns through Whop Ads.
inactive while a requested ads services agreement is awaiting the account’s signature.Available options: active, inactive, pendingstring
required
Standard payouts to an external payout destinationAvailable options:
active, inactive, pendingstring
required
Transfers to other accountsAvailable options:
active, inactive, pendingstring | null
required
Referred account logo URL.
object[] | null
required
Optional actions that unlock capabilities or grow the referred account.
Properties
Properties
string
required
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, launch_draft_campaign, increase_ad_budget, refresh_ad_creatives, fix_ad_billing, exclude_customers_from_ads, retarget_abandoned_checkouts, invite_team_member, enable_tax_collection, create_card, join_whop_university, apply_for_financingstring[]
required
Capabilities this would unlock, or empty
string
required
The URL the call-to-action links to
string
required
Button label
string
required
Supporting copy, or empty
string | null
required
Illustration icon URL, or
nullinteger | null
required
Estimated impact from 0-100, or
null when not rankedstring | null
required
Why this action was recommended, or
nullstring
required
Always optional — never blockingAvailable options:
optionalstring
required
Headline for the recommendation
object[] | null
required
Actions the referred account owner must take to unblock capabilities.
Properties
Properties
string
required
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_tracker, setup_apple_pay_domains, configure_tax_remitter, add_vat_registrationstring[]
required
Capabilities gated until this is resolved
string | null
required
The URL the call-to-action links to, or null when there is no button
string
required
Button label, or empty when there is no button
string
required
Supporting copy, or empty
string | null
required
The URL of the action’s illustration icon, or null if it has none
string
required
required (act now) or pending (under review)Available options:
required, pendingstring
required
Headline for the action
string
required
Referred account route.
string
required
Referred account display name.
string
required
When the partner business was created.
object
required
object | null
required
The partner who referred the business owner onto Whop (first tier). Null if there is no active first-tier partner.
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, secondstring
required
object | null
required
object
required
The referrer’s commission rate for each income source, expressed as a fraction (0.3 = 30%).
string | null
required
When the referral expires.
string | null
required
When the referral became active.
object | null
required
The second-tier partner who earns on this business (referred the first-tier partner). Null if there is no active second-tier partner.
string
required
Current referral status.Available options:
active, removedPartnerBusiness