Skip to main content
POST
TypeScript

Autorizaciones

Authorization
string
header
requerido

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

company:create
company:create_child

Encabezados

Idempotency-Key
string

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

Maximum string length: 255
Ejemplo:

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

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Cuerpo

application/json
affiliate_code
string | null

A saved partner referral link code for this new business account. An existing primary user referral takes priority. Used with user tokens creating top-level accounts.

Ejemplo:

"account-partner-link"

blueprint_id
string | null

The blueprint App ID, prefixed app_. Creates a hosted website for the account and queues its deployment asynchronously; the Account response does not report deployment completion.

Ejemplo:

"app_xxxxxxxxxxxxxx"

country
string

The ISO 3166-1 alpha-2 country code where the account's business is located (e.g. US). Defaults to the parent account's country for subaccounts.

Ejemplo:

"US"

dispute_fighter_enabled
boolean

Whether Whop assembles and files dispute evidence for this account. Enabling it opts into the success fee charged on disputes it wins. Requires payment:dispute. Omit to preserve the existing setting or creation default.

email
string

The email address of the account owner. Required when creating a subaccount.

Ejemplo:

"marcus@shinetime.example"

external_id
string | null

Your platform's own identifier for this subaccount, such as your user or store ID. Unique among your subaccounts: creating a second account with the same external_id and a different email returns a 409, unless reassign_external_id is true. Retrying with the same email and external_id returns the existing account. Subaccounts only.

Required string length: 1 - 255
Ejemplo:

"user_12345"

metadata
object

Arbitrary key/value metadata to store on the account. When external_id is not sent, an external_id key here sets external_id and follows its rules. It must be unique among your subaccounts unless reassign_external_id is true. It stays in metadata as sent. Changing it later does not change external_id.

Ejemplo:
orchestration_enabled
boolean

Whether payment orchestration is enabled for this account. Requires payout:account:update. Omit to preserve the existing setting or creation default.

reassign_external_id
boolean
predeterminado:false

Pass true to move external_id to the new subaccount when another of your subaccounts already has it. Without it, that request returns a 409. The subaccount that had it is not deleted. It stays active with external_id set to null, and its metadata is unchanged. Requires external_id. Also requires the company:update permission on your platform account, in addition to company:create_child. Ignored when the same email already has the external_id, which returns that account.

Ejemplo:

false

send_customer_emails
boolean
predeterminado:false

Whether Whop sends transactional emails to customers on behalf of the subaccount.

Ejemplo:

true

title
string

The display name of the account. Defaults to external_id or the owner's email when omitted.

Ejemplo:

"Referred Studio"

website
string | null

The account's business website, as an http or https URL of at most 255 characters. Also added to the account's social_links as a website entry.

Ejemplo:

"https://shinetimedetail.com"

Respuesta

account created

ads_spend_usd
number | null
requerido

Lifetime charged ad spend for the account, in USD. Computed only on list for callers with stats:read on the account; null otherwise.

Ejemplo:

0

balances
object[]
requerido
banner_image_url
string | null
requerido

Account banner image URL.

Ejemplo:

"https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

business_address
object | null
requerido

Account business address used to calculate tax, with line1, line2, city, state, postal_code, and country. null when no address is set.

Ejemplo:
business_name
string | null
requerido

The account's legal business name used with its tax address.

Maximum string length: 255
Ejemplo:

"Shine Time Auto Detailing, LLC"

business_type
string | null
requerido

High-level business category for the account. See the business types and industries glossary for valid values.

Ejemplo:

"software"

can_transfer_pending_balance_to_children
boolean
requerido

Whether pending funds may be transferred from this platform account to its subaccounts.

Ejemplo:

false

cancellation_policy
object | null
requerido

The account's cancellation policy document, or null if they have not published one.

capabilities
object | null
requerido

Payment rails enabled for this account, each active, inactive, or pending (onboarding or review in progress). Computed only on retrieve and me for callers with company:balance:read scope; null otherwise.

cards
object | null
requerido

Whop Cards application details for the account. Returned on list, retrieve, and me for callers with company:balance:read scope; null otherwise, or when the account has no card application or blocking application review.

collect_vat_id
boolean
requerido

Whether checkout shows a VAT/tax ID field for buyers to optionally enter. Does not require a VAT ID to purchase.

Ejemplo:

false

company_formation
object
requerido

Company formation state for the account, managed through Form Company. A draft status until the formation checkout is paid, then filing progress with downloadable documents and signatures awaiting action. Empty when the formation state is temporarily unavailable.

country
string | null
requerido

Country where the account is located.

Ejemplo:

"us"

created_at
string
requerido

When the account was created, as an ISO 8601 timestamp.

Ejemplo:

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

customers_l30d
integer | null
requerido

Distinct customers with a paid receipt at the account in the last 30 days, refreshed every few hours. Computed only on retrieve for callers with stats:read on the account; null otherwise, and when the count is unavailable.

Ejemplo:

null

description
string | null
requerido

Account promotional description.

Ejemplo:

"Mobile ceramic coating, paint correction, and interior detailing across the Austin metro."

dispute_fighter_enabled
boolean
requerido

Whether Whop assembles and files dispute evidence for this account. Enabling it opts the account into the success fee charged on disputes it wins.

Ejemplo:

false

economic_intelligence
boolean
requerido

Whether Economic Intelligence is on for the account. It turns off automatically when its committed period ends. While it is off, the account can't activate an experiment or run a recommendation.

Ejemplo:

false

email
string | null
requerido

Account owner email address.

Ejemplo:

"marcus@shinetime.example"

eula
object | null
requerido

The account's end-user license agreement document, or null if they have not published one.

external_id
string | null
requerido

The parent platform's own identifier for this subaccount, unique among the platform's subaccounts. null when unset.

Ejemplo:

"connected_account_123"

financing
object | null
requerido

The account's most recent financing application. Computed only on retrieve and me for callers with company:balance:read scope; null otherwise, or when the account has never applied for financing.

funds_release_at
string | null
requerido

When a suspended account can pay out its balance to its own payout method, as an ISO 8601 timestamp. A dispute can move it later. Computed on retrieve, me, and suspend; null otherwise, when status is not suspended, and when the suspension holds the balance.

Ejemplo:

null

home_preferences
enum<string>[]
requerido

Public account home page preferences.

Opciones disponibles:
hide_member_count,
hide_members_card
id
string
requerido

Account ID, prefixed biz_.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

industry_type
string | null
requerido

Specific industry vertical for the account. See the business types and industries glossary for valid values.

Ejemplo:

"trading"

invoice_prefix
string | null
requerido

Prefix used for account invoices.

Ejemplo:

"INV"

level
object | null
requerido

The Whop Levels progress of the account's owner, counted across every account they own, so all of them show the same level. Computed only on retrieve and me for callers with company:basic:read scope; null otherwise, and when the account is not in Whop Levels.

logo_url
string | null
requerido

Account logo image URL.

Ejemplo:

"https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

metadata
object
requerido

Arbitrary key/value metadata supplied at account creation.

Ejemplo:
onboarding_type
enum<string> | null
requerido

Type of onboarding the account has completed.

Opciones disponibles:
platform,
seller,
null
Ejemplo:

"platform"

opengraph_image_url
string | null
requerido

Account Open Graph image URL.

Ejemplo:

"https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

opengraph_image_variant
enum<string> | null
requerido

Account Open Graph image variant.

Opciones disponibles:
white,
black,
orange,
null
Ejemplo:

"black"

orchestration_enabled
boolean
requerido

Whether payment orchestration is enabled for this account.

Ejemplo:

true

other_business_description
string | null
requerido

Business type details when business_type is other.

Ejemplo:

null

other_industry_description
string | null
requerido

Industry details when industry_type is other.

Ejemplo:

null

owner
object
requerido

The single user who owns the account, whose email is the email above. Distinct from the owner role on team members, which any number of them can hold.

parent_account
object | null
requerido

Parent account for subaccounts, or null for standalone accounts.

payment_controls
object | null
requerido

Payment health controls currently applied to the account. Computed only on retrieve and me for callers with company:balance:read scope; null otherwise.

payment_method_configuration
object | null
requerido

The account's default payment methods at checkout. A variant's or checkout configuration's own payment_method_configuration takes precedence. null when the account uses Whop's platform defaults.

platform_credits
object[]
requerido
privacy_policy
object | null
requerido

The account's privacy policy document, or null if they have not published one.

product_tax_code
object | null
requerido

Tax classification code applied by default to the account's products, with id, name, and product_type. null when no default is set.

Ejemplo:

DEPRECATED: Use the GET /economic_intelligence?account_id={account_id} endpoint instead.

Ejemplo:

null

require_2fa
boolean
requerido

Whether authorized users must enable two-factor authentication.

Ejemplo:

false

required_actions
object[] | null
requerido
return_policy
object | null
requerido

The account's return policy document, or null if they have not published one.

route
string
requerido

Account public route identifier.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

send_customer_emails
boolean
requerido

Whether Whop sends transactional emails to customers on behalf of this account.

Ejemplo:

false

shipping_policy
object | null
requerido

The account's shipping policy document, or null if they have not published one.

show_joined_whops
boolean
requerido

Whether the account appears in joined whops on other accounts.

Ejemplo:

true

show_reviews_dtc
boolean
requerido

Whether reviews are displayed on direct-to-consumer product pages.

Ejemplo:

true

show_user_directory
boolean
requerido

Whether the account shows users in the user directory.

Ejemplo:

true

status
string | null
requerido

Whether the account can operate on Whop: active or suspended. Computed on list, retrieve, me, and suspend; null otherwise.

Ejemplo:

"active"

status_reason
string | null
requerido

Why the account was suspended, as a label such as Suspended - Fraudulent activity. Suspended when no reason is recorded. Computed on retrieve, me, and suspend. null otherwise, or when status is not suspended.

Ejemplo:

"Suspended - Fraudulent activity"

store_page_config
object
requerido

Account store page display configuration.

target_audience
string | null
requerido

Target audience for this account.

Ejemplo:

"Owners of new and enthusiast vehicles in Austin, TX"

tax_collection_enabled_states
string[]
requerido

US state codes (of the 50 states plus DC) where the account collects tax: the full set when Whop remits (tax_remitted_by whop), the configured subset when the account self-remits (self), and empty when neither. On update, send the complete list to replace it (only allowed when self).

tax_identifiers
object[]
requerido
tax_remitted_by
enum<string> | null
requerido

Who calculates and remits tax for the account. whop means Whop calculates and remits. self means Whop calculates, and the account collects and remits. none means neither, and the account is responsible. New businesses start on whop, and new connected accounts start on none. null means the account has no setting yet.

Opciones disponibles:
whop,
self,
none,
null
Ejemplo:

"self"

tax_type
enum<string> | null
requerido

How tax is applied to the account's prices: inclusive (tax included in the listed price) or exclusive (tax added on top). Defaults to exclusive when unset; null only when the account has no payment connection.

Opciones disponibles:
inclusive,
exclusive,
null
Ejemplo:

"inclusive"

terms_of_service
object | null
requerido

The account's terms of service document, or null if they have not published one.

three_ds_level
enum<string> | null
requerido

3D Secure behavior for supported on-session card payments. mandate_challenge requires a 3DS challenge before payment processing; mandate_if_required mandates a challenge only when the payment processor requires it; frictionless_if_required uses the regular frictionless 3DS flow. Payments of $1,000 or more use mandate_if_required unless mandate_challenge is selected. Risk and authentication recovery requirements can override the preference. null uses the standard checkout flow.

Opciones disponibles:
mandate_challenge,
mandate_if_required,
frictionless_if_required,
null
Ejemplo:

"mandate_challenge"

title
string
requerido

Account display name.

Ejemplo:

"Shine Time Auto Detailing"

total_earned_usd
number | null
requerido

Account lifetime sales, normalized to USD. Computed only on retrieve and me for callers with stats:read scope; null otherwise.

Ejemplo:

0

total_usd
string | null
requerido

Total USD value across balances with known exchange rates. Computed only on single-account reads (retrieve and me); null on list responses, writes, missing balance-read permission, or unavailable balance source.

Ejemplo:

"50.00"

trading
object | null
requerido

The trading account address, a snapshot of its margin and open positions, and its WebSocket subscriptions. Opt in with include_trading=true on single-account reads. null otherwise, without trading permission, or without an Ethereum wallet.

use_logo_as_opengraph_image_fallback
boolean
requerido

Whether the account uses its logo as the fallback Open Graph image.

Ejemplo:

false

verification
object
requerido

Account identity verification status for the individual (KYC) and business (KYB) profiles. Each is null until created, otherwise a status of not_started, pending, manual_review, approved, or rejected.

Ejemplo:
volume_l30d_usd
number | null
requerido

Volume through the account in the last 30 days (GMV from paid receipts), normalized to USD. Computed only on list for callers with stats:read on the account; null otherwise.

Ejemplo:

0

volume_usd
number | null
requerido

Lifetime volume through the account — sales plus transfers received — normalized to USD. Computed only on list for callers with stats:read on the account; null otherwise.

wallet
object | null
requerido

Account primary crypto wallet, or null if none has been provisioned.

website
string | null
requerido

The account's business website URL, or null if none has been provided. Setting it also adds a website entry to social_links.

Ejemplo:

"https://shinetimedetail.com"

direct_reports_count
integer

How many team members report to the business directly, with no manager above them. Present on single-account reads.

Ejemplo:

0

partner
object | null

The account's active first-tier partner. Present on retrieve responses; null when no active first-tier partner is attributed to the account. Omitted from other responses.

rewards
object[]
whop_partner_enabled_at
string | null

When the account turned on Whop Partner mode, as an ISO 8601 timestamp. Present on single-account reads and update responses; null until the account turns Whop Partner mode on by sending whop_partner_enabled: true on update.

Ejemplo:

null