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": "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",
  "deal_closed_reason": null,
  "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,
    "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_projections_allowed": false,
  "commission_advance_rate": null,
  "pending_owner_invites": [
    {
      "email": "<string>",
      "id": "<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": "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",
  "deal_closed_reason": null,
  "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,
    "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_projections_allowed": false,
  "commission_advance_rate": null,
  "pending_owner_invites": [
    {
      "email": "<string>",
      "id": "<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-10-24"

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

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"

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 referrer's commission rate for each income source, expressed as a fraction (0.3 = 30%).

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. Omitted for other callers. An offer token requires partner:commission_advance:accept permission.

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 2500 USD, and round down to cents. Uses observed commissions or, without history, reference US card fees minus estimated percentage costs 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

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Retrieve a Referred Business

Authorizations

Headers

Path Parameters

Response