id and wallet details, and use metadata to store your own stable identifier, like a user ID from your system.
Endpoints
| Endpoint | Request |
|---|---|
| Create Account | POST /accounts |
| Update Account | PATCH /accounts/{account_id} |
| Retrieve Account | GET /accounts/{account_id} |
| Retrieve Requesting Account | GET /accounts/me |
| List Accounts | GET /accounts |
Attributes
Account holdings, each with USD value. Empty when
total_usd is null.Properties
Properties
Total amount held in native units, as a decimal string.
Balance split into available, pending, and reserve amounts, as native-unit
decimal strings. On-chain crypto is entirely available; good_funds and fiat
cash can have pending or reserve portions.
Holding icon URL.
The holding’s display name
USD price per unit, or
null when no exchange rate is available.Holding display symbol, such as
USDT, cbBTC, or EUR.Holding USD value, or
null when no exchange rate is available.Account banner image URL.
Account business address used to calculate tax, with
line1, line2, city,
state, postal_code, and country. null when no address is set.High-level business category for the account.
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 where the account is located.
When the account was created, as an ISO 8601 timestamp.
Account promotional description.
Account owner email address.
Public account home page preferences.
Account ID, prefixed
biz_.Account industry group.
Specific industry vertical for the account.
Prefix used for account invoices.
Account logo image URL.
Arbitrary key/value metadata supplied at account creation.
Type of onboarding the account has completed.
Account Open Graph image URL.
Account Open Graph image variant.
Business type details when business_type is
other.Industry details when industry_type is
other.Parent account ID for connected accounts.
Tax classification code applied by default to the account’s products, with
id, name, and product_type. null when no default is set.Optional actions that unlock capabilities or grow the account, same shape as
required_actions. Computed only on retrieve and me; null otherwise.Properties
Properties
The recommendation; new values may be added, so handle unknown actions gracefullyAvailable options:
apply_for_financing, migrate_from_stripe, accept_first_payment, join_whop_universityCapabilities this would unlock, or empty
The URL the call-to-action links to
Button label
Supporting copy, or empty
Illustration icon URL, or
nullAlways optional — never blockingAvailable options:
optionalHeadline for the recommendation
Whether authorized users must enable two-factor authentication.
Actions the account owner must take to unblock capabilities like payouts and card spend, ordered by display priority. Computed only on
retrieve and me for callers with company:balance:read scope; null otherwise.Properties
Properties
What the holder must do; new values may be added, so handle unknown actions gracefullyAvailable options:
deposit_funds, submit_information_request, verify_identity, connect_fulfillment_trackerCapabilities gated until this is resolved
The URL the call-to-action links to, or null when there is no button
Button label, or empty when there is no button
Supporting copy, or empty
The URL of the action’s illustration icon, or null if it has none
required (act now) or pending (under review)Available options:
required, pendingHeadline for the action
Account public route identifier.
Whether Whop sends transactional emails to customers on behalf of this
account.
Whether the account appears in joined whops on other accounts.
Whether reviews are displayed on direct-to-consumer product pages.
Whether the account shows users in the user directory.
Account social links.
Properties
Properties
The ID of the social link
The optional display title for the social link
The social link URL
The social platform for this linkAvailable options:
x, instagram, facebook, tiktok, youtube, linkedin, twitch, website, customWhether the account can operate on Whop:
active or suspended. Computed
only on retrieve and me; null otherwise.Account store page display configuration.
Target audience for this account.
Account tax/VAT registrations, each with
id, tax_id_type, and
tax_id_value. Empty when none are set.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.Account display name.
Account lifetime sales, normalized to USD. Computed only on
retrieve and
me for callers with stats:read scope; null otherwise.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.Whether the account uses its logo as the fallback Open Graph image.
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.Account primary crypto wallet, or
null if none has been provisioned.Account