Skip to main content
POST
Resend an owner invite

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-03-1"

Path Parameters

id
string
required

The partner business ID (a coma_ identifier).

Body

application/json
invite_id
string
required

The outstanding invite to resend (an ausri_ identifier from pending_owner_invites).

Example:

"ausri_xxxxxxxxxxxxxx"

Response

invite resent

account
object | null
required

Referred account.

blueprint_partner
object | null
required

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

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

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), second (they referred the first-tier partner), or blueprint (the business deployed a site from their blueprint).

Available options:
first,
second,
blueprint
Example:

"first"

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.

object
enum<string>
required
Available options:
partner_business
Example:

"partner_business"

owner
object | null
required

The owner of the referred business.

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.

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.

status
enum<string>
required

Current referral status.

Available options:
active,
removed
Example:

"active"

volume_usd
object
required
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_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

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.