Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

account_id
string
required

Account ID, prefixed biz_.

Response

account retrieved

balances
object[]
required
banner_image_url
string | null
required

Account banner image URL.

business_address
object | null
required

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

business_type
string | null
required

High-level business category for the account.

capabilities
object | null
required

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.

country
string | null
required

Country where the account is located.

created_at
string
required

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

description
string | null
required

Account promotional description.

email
string | null
required

Account owner email address.

home_preferences
string[]
required

Public account home page preferences.

id
string
required

Account ID, prefixed biz_.

industry_group
string | null
required

Account industry group.

industry_type
string | null
required

Specific industry vertical for the account.

invoice_prefix
string | null
required

Prefix used for account invoices.

llc_formation
object
required

LLC formation state for the account: a draft state with payment_pending, or the live filing state with registration progress, documents, and pending signatures.

logo_url
string | null
required

Account logo image URL.

metadata
object
required

Arbitrary key/value metadata supplied at account creation.

onboarding_type
string | null
required

Type of onboarding the account has completed.

opengraph_image_url
string | null
required

Account Open Graph image URL.

opengraph_image_variant
string | null
required

Account Open Graph image variant.

other_business_description
string | null
required

Business type details when business_type is other.

other_industry_description
string | null
required

Industry details when industry_type is other.

parent_account_id
string | null
required

Parent account ID for connected accounts.

payment_controls
object | null
required

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

product_tax_code
object | null
required

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

DEPRECATED: Use the GET /accounts/{account_id}/recommend_actions endpoint instead.

require_2fa
boolean
required

Whether authorized users must enable two-factor authentication.

required_actions
object[] | null
required
route
string
required

Account public route identifier.

send_customer_emails
boolean
required

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

show_joined_whops
boolean
required

Whether the account appears in joined whops on other accounts.

show_reviews_dtc
boolean
required

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

show_user_directory
boolean
required

Whether the account shows users in the user directory.

status
string | null
required

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

store_page_config
object
required

Account store page display configuration.

target_audience
string | null
required

Target audience for this account.

tax_collection_enabled_states
string[]
required

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
array
required

Account tax/VAT registrations, each with id, tax_id_type, and tax_id_value. Empty when none are set.

tax_remitted_by
string | null
required

Who calculates and remits tax for the account: whop (Whop calculates and remits), self (Whop calculates; the account collects and remits), or none (neither; the account is responsible). null until the account enrolls in the Whop tax service.

title
string
required

Account display name.

total_earned_usd
number | null
required

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

total_usd
string | null
required

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.

use_logo_as_opengraph_image_fallback
boolean
required

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

verification
object
required

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

wallet
object | null
required

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