Partners

Retrieve a referred business

Changed on

Retrieves a single referred business and its referral terms. The original referrer or a caller with company:basic:read on the business credited for the referral can read it.

get/partners/businesses/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/partners/businesses/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Response

partner business retrieved

commission_advance_projections_allowedboolean

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.

commission_advance_ratestring nullable

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.

created_atstring date-time required

When the partner business was created.

idstring required

Partner business ID.

my_partner_tier'first' | 'second' | 'blueprint' 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).

object'partner_business' required
referral_expires_atstring date-time nullable required

When the referral expires.

referral_started_atstring date-time nullable required

When the referral became active.

status'active' | 'removed' required

Current referral status.

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": "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"
  },
  "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
    },
    "deadline_at": "2026-01-01T12:00:00.000Z",
    "estimated_amount": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "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"
  },
  "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": {
    "sales": 0.3
  },
  "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"
  }
}

Changes

  • 2595dc1a6c8bRevision changes
    • info

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope company:basic:read was removed from the endpoint's security scheme bearerAuth

  • ac4774bfce4aRevision changes
    • info

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope company:basic:read was removed from the endpoint's security scheme bearerAuth