Skip to main content
GET
TypeScript

인증

Authorization
string
header
필수

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.

Scopes

partner:basic:read
referral:basic:read
company:basic:read

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

경로 매개변수

id
string
필수

The partner business ID (a coma_ identifier).

응답

partner business retrieved

account
object | null
필수

Referred account.

blueprint_partner
object | null
필수

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

can_edit_fees
boolean
필수

Whether the caller can change the fees of this business. true for the Whop Verified Partner who referred it. Also true for a verified partner in the same team who manages that partner or can update every reporting line. Read and change the fees with the account fees endpoints.

예시:

false

created_at
string<date-time>
필수

When the partner business was created.

예시:

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

deal_closed_reason
string | null
필수

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

예시:

null

earnings_usd
object
필수
estimated_commission_rate
string | null
필수

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.

예시:

null

first_tier_partner
object | null
필수

The partner who referred the business owner onto Whop (first tier). Null if there is no active first-tier partner.

id
string
필수

Partner business ID.

예시:

"coma_xxxxxxxxxxxxxx"

my_partner_tier
enum<string>
필수

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).

사용 가능한 옵션:
first,
second,
blueprint
예시:

"blueprint"

my_payout_percentages
object | null
필수

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.

object
enum<string>
필수
사용 가능한 옵션:
partner_business
예시:

"partner_business"

owner
object | null
필수

The owner of the referred business.

payout_percentages
object
필수

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.

referral_expires_at
string<date-time> | null
필수

When the referral expires.

예시:

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

referral_started_at
string<date-time> | null
필수

When the referral became active.

예시:

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

second_tier_partner
object | null
필수

The second-tier partner who earns on this business (referred the first-tier partner). Null if there is no active second-tier partner.

status
enum<string>
필수

Current referral status.

사용 가능한 옵션:
active,
removed
예시:

"active"

volume_usd
object
필수
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.

commission_advance_cap
object

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

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.

예시:

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.

예시:

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.

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.