Retrieve a referred business

Retrieves a single referred business and its referral terms.

GET /partners/businesses/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const business = await client.partners.businesses.retrieve('id');

console.log(business.id);

200

{
  "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"
  },
  "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": "Tanya Cole",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "tanyacole"
  },
  "id": "coma_xxxxxxxxxxxxxx",
  "my_partner_tier": "second",
  "object": "partner_business",
  "owner": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Nina Alvarez",
    "profile_picture": {
      "url": "https://ui-avatars.com/api/"
    },
    "username": "ninaalvarez"
  },
  "payout_percentages": {
    "ad_spend": 0.015,
    "card_interchange": 0.2,
    "sales": 0.1,
    "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"
  }
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

id · string · required

The partner business ID (a coma_ identifier).

Response

200

application/json

partner business retrieved

account · object | null · required

Referred account.

Show child attributes

created_at · string<date-time> · required

When the partner business was created.

Example:

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

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

id · 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) or second (they referred the first-tier partner).

Available options: first, second

Example:

"second"

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