Retrieve a referred business
Retrieves a single referred business and its referral terms.
Response
partner business retrieved
Example response
{
"account": {
"capabilities": {
"accept_bank_payments": "active",
"accept_bnpl_payments": "inactive",
"accept_card_payments": "active",
"bank_deposit": "inactive",
"card_deposit": "active",
"card_issuing": "inactive",
"crypto_deposit": "active",
"crypto_payout": "inactive",
"instant_payout": "inactive",
"run_ads": "active",
"standard_payout": "inactive",
"transfer": "inactive"
},
"id": "biz_xxxxxxxxxxxxxx",
"logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"recommended_actions": [
{
"action": "apply_for_financing",
"blocked_capabilities": [
"accept_bnpl_payments"
],
"cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/settings/payments/",
"cta_label": "Apply",
"description": "Let customers pay over time with buy now, pay later.",
"icon_url": "https://whop.com/illustrations/orange/piggy-bank.svg",
"impact_score": 86,
"reasoning": "Financing lifts conversion on the $249 ceramic coating, the priciest job on the menu.",
"status": "optional",
"title": "Offer financing at checkout"
}
],
"required_actions": [
{
"action": "verify_identity",
"blocked_capabilities": [
"standard_payout"
],
"cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/balance/",
"cta_label": "Verify now",
"description": "Complete verification to withdraw your earnings.",
"icon_url": "https://whop.com/illustrations/orange/shield.svg",
"status": "required",
"title": "Complete your identity verification"
}
],
"route": "biz_xxxxxxxxxxxxxx",
"title": "Gleam Mobile Detailing"
},
"blueprint_partner": {
"id": "user_xxxxxxxxxxxxxx",
"name": "Marcus Webb",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "marcuswebb"
},
"created_at": "2026-01-01T12:00:00.000Z",
"earnings_usd": {
"completed": "0.00",
"pending": "0.00",
"total": "0.00"
},
"first_tier_partner": {
"id": "user_xxxxxxxxxxxxxx",
"name": "Marcus Webb",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "marcuswebb"
},
"id": "coma_xxxxxxxxxxxxxx",
"my_partner_tier": "blueprint",
"object": "partner_business",
"owner": {
"email": "marcus@shinetime.example",
"id": "user_xxxxxxxxxxxxxx",
"name": "Tanya Cole",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "tanyacole"
},
"payout_percentages": {
"ad_spend": 0.015,
"card_interchange": 0.2,
"sales": 0.3,
"transfer": 0.25
},
"referral_expires_at": "2026-01-01T12:00:00.000Z",
"referral_started_at": "2026-01-01T12:00:00.000Z",
"second_tier_partner": {
"id": "user_xxxxxxxxxxxxxx",
"name": "Marcus Webb",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "marcuswebb"
},
"status": "active",
"volume_usd": {
"attributed": "0.00",
"awaiting_settlement": "0.00",
"settled": "0.00"
}
}Changes
Changed in 12 of the 43 revisions of this API.11610
- ○
added the required property
blueprint_partnerto the response with the200statusresponse-required-property-added
- ○
added the required property
owner/emailto the response with the200statusresponse-required-property-added
- ○
- ●
added the new
blueprintenum value to themy_partner_tierresponse property for the response status200response-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
reauthorize_payout_methodsenum value to theaccount/required_actions/items/actionresponse property for the response status200response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ○
removed the
setup_tracking_pixelenum value from theaccount/recommended_actions/items/actionresponse property for the response status200response-property-enum-value-removed
- ○
- ●
added the new
update_payout_profileenum value to theaccount/required_actions/items/actionresponse property for the response status200response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
card_usage_reviewenum value to theaccount/required_actions/items/actionresponse property for the response status200response-property-enum-value-added
- ●
- ●
added the new
fix_funnel_dropoffenum value to theaccount/recommended_actions/items/actionresponse property for the response status200response-property-enum-value-added
- ●
added the new
sign_formation_documentsenum value to theaccount/required_actions/items/actionresponse property for the response status200response-property-enum-value-added
- ○
removed the
join_whop_universityenum value from theaccount/recommended_actions/items/actionresponse property for the response status200response-property-enum-value-removed
- ●
- ○
added the optional property
error/codeto the response with the404statusresponse-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ●
added the new
add_vat_registrationenum value to theaccount/required_actions/items/actionresponse property for the response status200response-property-enum-value-added
- ●
- ●
added the new
configure_tax_remitterenum value to theaccount/required_actions/items/actionresponse property for the response status200response-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
Of the 43 revisions, 1 has no diff computed.