Retrieve a Referred Business

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.partners.businesses.retrieve({
    id: "id"
});

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/partners/businesses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/partners/businesses/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/partners/businesses/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/partners/businesses/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "account": {
    "capabilities": {
      "accept_bank_payments": "active",
      "accept_bnpl_payments": "inactive",
      "accept_card_payments": "active",
      "bank_deposit": "inactive",
      "card_deposit": "inactive",
      "card_issuing": "inactive",
      "crypto_deposit": "active",
      "crypto_payout": "inactive",
      "instant_payout": "inactive",
      "run_ads": "inactive",
      "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": "theme_business",
        "blocked_capabilities": [
          "<string>"
        ],
        "cta": "<string>",
        "cta_label": "<string>",
        "description": "<string>",
        "icon_url": "<string>",
        "impact_score": 123,
        "reasoning": "<string>",
        "status": "optional",
        "title": "<string>"
      }
    ],
    "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",
  "deal_closed_reason": null,
  "earnings_usd": {
    "completed": "0.00",
    "pending": "0.00",
    "total": "0.00"
  },
  "estimated_commission_rate": null,
  "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",
  "my_payout_percentages": {
    "ad_spend": 0,
    "card_interchange": 0,
    "sales": 0.3,
    "transfer": 0,
    "withdrawal": 0
  },
  "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,
    "card_interchange": 0,
    "sales": 0.3,
    "transfer": 0,
    "withdrawal": 0
  },
  "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",
    "last_30d": "0.00",
    "settled": "0.00"
  },
  "commission_advance": {
    "activity_30_day": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "activity_60_day": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "amount": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "annual_processing": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "clawed_back_at": null,
    "deadline_at": "2026-01-01T12:00:00.000Z",
    "estimated_amount": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "funded_at": null,
    "offer_token": null,
    "processing_target": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "projected_60_day_activity": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "projected_commissions": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "projected_processing_commissions": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "qualified_at": "2026-01-01T12:00:00.000Z",
    "recovery_threshold": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "status": "accepted",
    "terms_version": "2026-01-01"
  },
  "commission_advance_cap": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "commission_advance_projections_allowed": false,
  "commission_advance_rate": null,
  "pending_owner_invites": [
    {
      "email": "<string>",
      "id": "<string>"
    }
  ],
  "referring_business": {
    "id": "<string>",
    "logo_url": "<string>",
    "route": "<string>",
    "title": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

partners

businesses

{id}

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.partners.businesses.retrieve({
    id: "id"
});

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/partners/businesses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/partners/businesses/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/partners/businesses/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/partners/businesses/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "account": {
    "capabilities": {
      "accept_bank_payments": "active",
      "accept_bnpl_payments": "inactive",
      "accept_card_payments": "active",
      "bank_deposit": "inactive",
      "card_deposit": "inactive",
      "card_issuing": "inactive",
      "crypto_deposit": "active",
      "crypto_payout": "inactive",
      "instant_payout": "inactive",
      "run_ads": "inactive",
      "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": "theme_business",
        "blocked_capabilities": [
          "<string>"
        ],
        "cta": "<string>",
        "cta_label": "<string>",
        "description": "<string>",
        "icon_url": "<string>",
        "impact_score": 123,
        "reasoning": "<string>",
        "status": "optional",
        "title": "<string>"
      }
    ],
    "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",
  "deal_closed_reason": null,
  "earnings_usd": {
    "completed": "0.00",
    "pending": "0.00",
    "total": "0.00"
  },
  "estimated_commission_rate": null,
  "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",
  "my_payout_percentages": {
    "ad_spend": 0,
    "card_interchange": 0,
    "sales": 0.3,
    "transfer": 0,
    "withdrawal": 0
  },
  "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,
    "card_interchange": 0,
    "sales": 0.3,
    "transfer": 0,
    "withdrawal": 0
  },
  "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",
    "last_30d": "0.00",
    "settled": "0.00"
  },
  "commission_advance": {
    "activity_30_day": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "activity_60_day": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "amount": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "annual_processing": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "clawed_back_at": null,
    "deadline_at": "2026-01-01T12:00:00.000Z",
    "estimated_amount": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "funded_at": null,
    "offer_token": null,
    "processing_target": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "projected_60_day_activity": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "projected_commissions": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "projected_processing_commissions": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "qualified_at": "2026-01-01T12:00:00.000Z",
    "recovery_threshold": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "status": "accepted",
    "terms_version": "2026-01-01"
  },
  "commission_advance_cap": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "commission_advance_projections_allowed": false,
  "commission_advance_rate": null,
  "pending_owner_invites": [
    {
      "email": "<string>",
      "id": "<string>"
    }
  ],
  "referring_business": {
    "id": "<string>",
    "logo_url": "<string>",
    "route": "<string>",
    "title": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-11-04-1"

Path Parameters

string

required

The partner business ID (a coma_ identifier).

Response

partner business retrieved

account

object | null

required

Referred account.

Show child attributes

blueprint_partner

object | null

required

The partner whose blueprint the business deployed. Null unless this is a blueprint referral.

Show child attributes

created_at

string<date-time>

required

When the partner business was created.

Example:

"2026-01-01T12:00:00.000Z"

deal_closed_reason

string | null

required

How the partner closed this business, in their own words. Null until the partner saves one.

Example:

null

earnings_usd

object

required

Show child attributes

estimated_commission_rate

string | null

required

Estimated regular commission per USD of card and BNPL payments, as a decimal string (for example 0.004). Once the advance qualifies, the rate its terms were sized with; before that, observed payout rates or, without payment history, reference US card fees. Multiply payments by this rate to estimate commissions, including those that resume after a commission advance term. null when pricing is unavailable or the response has neither commission_advance_rate nor commission_advance.

Example:

null

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.

Show child attributes

string

required

Partner business ID.

Example:

"coma_xxxxxxxxxxxxxx"

my_partner_tier

enum<string>

required

Which tier the caller earns on for this business: first (they referred the owner), second (they referred the first-tier partner), or blueprint (the business deployed a site from their blueprint).

Available options:

first,

second,

blueprint

Example:

"blueprint"

my_payout_percentages

object | null

required

The caller's own cut of each income source on this business, as a fraction of the same base as payout_percentages (0.12 = 12%). A solo partner's cut is the whole rate. On a referring partner business's deal it is the caller's team share of the rate: a closer earns their share, a manager earns their share minus the share of the person below them, and a deal participant earns their cut. Null when the caller earns nothing on this business, as with an account API key.

Show child attributes

object

enum<string>

required

Available options:

partner_business

Example:

"partner_business"

owner

object | null

required

The owner of the referred business.

Show child attributes

payout_percentages

object

required

The commission rate this referral pays for each income source, as a fraction (0.3 = 30%). A solo partner earns it directly; the team of a referring partner business splits it by their shares.

Show child attributes

referral_expires_at

string<date-time> | null

required

When the referral expires.

Example:

"2026-01-01T12:00:00.000Z"

referral_started_at

string<date-time> | null

required

When the referral became active.

Example:

"2026-01-01T12:00:00.000Z"

second_tier_partner

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.

Show child attributes

status

enum<string>

required

Current referral status.

Available options:

active,

removed

Example:

"active"

volume_usd

object

required

Show child attributes

commission_advance

object | null

CPA terms for the referring partner. Read with referring_account_id, the business's owner sees every rep's terms and a manager sees those of the reps below them, read-only. Omitted for other callers. An offer token is only for the referring partner and requires partner:commission_advance:accept permission.

Show child attributes

commission_advance_cap

object

The most the referring organization advances per business, in USD. Returned only with commission_advance_rate.

Show child attributes

commission_advance_projections_allowed

boolean

Whether this referral meets the partner and ownership requirements for saving commission advance projections. Returned only to the referring partner; existing advance terms and update permissions still apply.

Example:

false

commission_advance_rate

string | null

Estimated upfront advance per USD of annual card and BNPL payments, including advance share and remaining term. Multiply annual payments by this rate, cap at commission_advance_cap, and round down to cents. Uses observed commissions or, without history, a typical gross profit share adjusted for the business's US card fee, times the partner share. Null when projections or pricing are unavailable. Only returned to the referring partner. Qualification and final offers use actual activity.

Example:

null

pending_owner_invites

object[]

Outstanding invites to claim ownership of this business. Present only to the first-tier partner's whop.com session, or the Whop CLI or MCP with the partner:handoff scope, and empty once every invite has been accepted.

Show child attributes

referring_business

object | null

The partner business whose team member made this referral, the one its commission is paid to. Null for a solo partner's referral.

Show child attributes

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Retrieve a Referred Business

Authorizations

Headers

Path Parameters

Response