Skip to main content
GET
TypeScript

Autorisations

Authorization
string
header
requis

An Account API key, an account access token, an account-scoped user token, 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:basic:read
company:balance:read

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Account ID, prefixed biz_, its public route, or me for the account associated with the current Account API key. User tokens have no single account, so they cannot use me.

Paramètres de requête

include_trading
boolean
défaut:false

Also return the trading account under trading: its address, a snapshot of its margin and open positions, and its Hyperliquid WebSocket subscriptions. Requires crypto_wallet:trade:read, crypto_wallet:trade, or crypto_wallet:manage permission and an Ethereum wallet. Otherwise trading is null.

Réponse

account with an individual card application

ads_spend_usd
number | null
requis

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

Exemple:

0

balances
object[]
requis
banner_image_url
string | null
requis

Account banner image URL.

Exemple:

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

business_address
object | null
requis

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

Exemple:
business_name
string | null
requis

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

Maximum string length: 255
Exemple:

"Shine Time Auto Detailing, LLC"

business_type
string | null
requis

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

Exemple:

"software"

can_transfer_pending_balance_to_children
boolean
requis

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

Exemple:

false

cancellation_policy
object | null
requis

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

capabilities
object | null
requis

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
requis

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
requis

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

Exemple:

false

company_formation
object
requis

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
requis

Country where the account is located.

Exemple:

"us"

created_at
string
requis

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

Exemple:

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

customers_l30d
integer | null
requis

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.

Exemple:

null

description
string | null
requis

Account promotional description.

Exemple:

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

dispute_fighter_enabled
boolean
requis

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

Exemple:

false

economic_intelligence
boolean
requis

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.

Exemple:

false

email
string | null
requis

Account owner email address.

Exemple:

"marcus@shinetime.example"

eula
object | null
requis

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

external_id
string | null
requis

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

Exemple:

"connected_account_123"

financing
object | null
requis

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
requis

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.

Exemple:

null

home_preferences
enum<string>[]
requis

Public account home page preferences.

Options disponibles:
hide_member_count,
hide_members_card
id
string
requis

Account ID, prefixed biz_.

Exemple:

"biz_xxxxxxxxxxxxxx"

industry_type
string | null
requis

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

Exemple:

"trading"

invoice_prefix
string | null
requis

Prefix used for account invoices.

Exemple:

"INV"

level
object | null
requis

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
requis

Account logo image URL.

Exemple:

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

metadata
object
requis

Arbitrary key/value metadata supplied at account creation.

Exemple:
onboarding_type
enum<string> | null
requis

Type of onboarding the account has completed.

Options disponibles:
platform,
seller,
null
Exemple:

"platform"

opengraph_image_url
string | null
requis

Account Open Graph image URL.

Exemple:

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

opengraph_image_variant
enum<string> | null
requis

Account Open Graph image variant.

Options disponibles:
white,
black,
orange,
null
Exemple:

"black"

orchestration_enabled
boolean
requis

Whether payment orchestration is enabled for this account.

Exemple:

true

other_business_description
string | null
requis

Business type details when business_type is other.

Exemple:

null

other_industry_description
string | null
requis

Industry details when industry_type is other.

Exemple:

null

owner
object
requis

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
requis

Parent account for subaccounts, or null for standalone accounts.

payment_controls
object | null
requis

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
requis

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[]
requis
privacy_policy
object | null
requis

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

product_tax_code
object | null
requis

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

Exemple:

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

Exemple:

null

require_2fa
boolean
requis

Whether authorized users must enable two-factor authentication.

Exemple:

false

required_actions
object[] | null
requis
return_policy
object | null
requis

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

route
string
requis

Account public route identifier.

Exemple:

"biz_xxxxxxxxxxxxxx"

send_customer_emails
boolean
requis

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

Exemple:

false

shipping_policy
object | null
requis

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

show_joined_whops
boolean
requis

Whether the account appears in joined whops on other accounts.

Exemple:

true

show_reviews_dtc
boolean
requis

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

Exemple:

true

show_user_directory
boolean
requis

Whether the account shows users in the user directory.

Exemple:

true

status
string | null
requis

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

Exemple:

"active"

status_reason
string | null
requis

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.

Exemple:

"Suspended - Fraudulent activity"

store_page_config
object
requis

Account store page display configuration.

target_audience
string | null
requis

Target audience for this account.

Exemple:

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

tax_collection_enabled_states
string[]
requis

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[]
requis
tax_remitted_by
enum<string> | null
requis

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.

Options disponibles:
whop,
self,
none,
null
Exemple:

"self"

tax_type
enum<string> | null
requis

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.

Options disponibles:
inclusive,
exclusive,
null
Exemple:

"inclusive"

terms_of_service
object | null
requis

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

three_ds_level
enum<string> | null
requis

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.

Options disponibles:
mandate_challenge,
mandate_if_required,
frictionless_if_required,
null
Exemple:

"mandate_challenge"

title
string
requis

Account display name.

Exemple:

"Shine Time Auto Detailing"

total_earned_usd
number | null
requis

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

Exemple:

0

total_usd
string | null
requis

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.

Exemple:

"50.00"

trading
object | null
requis

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
requis

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

Exemple:

false

verification
object
requis

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.

Exemple:
volume_l30d_usd
number | null
requis

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.

Exemple:

0

volume_usd
number | null
requis

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
requis

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

website
string | null
requis

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

Exemple:

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

Exemple:

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.

Exemple:

null