Update Account
Updates an account. User tokens can update business accounts; business account API keys can update connected accounts.
Authorizations
An account API key, account scoped JWT, app API key, or user OAuth token.
Path Parameters
Account ID, prefixed biz_.
Body
Whether prospective affiliates must submit an application before promoting this account.
Guidelines shown to affiliates promoting this account.
Attachment input for the account banner image.
High-level business category for the account.
Country where the account is located.
Account promotional description.
The ID of the product to feature for affiliates. Pass null to clear.
Public account home page preferences.
Account industry group.
Specific industry vertical for the account.
Prefix used for account invoices.
Attachment input for the account logo.
The type of onboarding the account has completed.
Attachment input for the account Open Graph image.
The account Open Graph image variant.
The description of the business type when business_type is other.
The description of the industry type when industry_type is other.
Whether the account requires authorized users to have two-factor authentication enabled.
The unique URL slug for the account.
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.
The full list of social links to display for the account.
Account store page display configuration.
The target audience for this account.
The display name of the account.
Whether the account uses its logo as the fallback Open Graph image.
Arbitrary key/value metadata to store on the account.
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). self requires a business_address in a supported country.
whop, self, none ID of the tax classification code applied by default to the account's products.
Account business address used to calculate tax. A complete address in a supported country is required when tax_remitted_by is self.
Account tax/VAT registrations to add or update. When tax_remitted_by is self, tax is calculated and collected only in the countries where the account holds a registration.
Response
account updated
Account ID, prefixed biz_.
Account owner email address.
Account display name.
Account promotional description.
Account public route identifier.
Account logo image URL.
Account banner image URL.
High-level business category for the account.
Country where the account is located.
Public account home page preferences.
Account industry group.
Specific industry vertical for the account.
Prefix used for account invoices.
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.
Whether authorized users must enable two-factor authentication.
Target audience for this account.
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 store page display configuration.
Parent account ID for connected accounts.
Arbitrary key/value metadata supplied at account creation.
When the account was created, as an ISO 8601 timestamp.
Whether the account uses its logo as the fallback Open Graph image.
Account lifetime sales, normalized to USD. Computed only on retrieve and me for callers with stats:read scope; null otherwise.
Whether the account can operate on Whop: active or suspended. Computed only on retrieve and me; null otherwise.
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.
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.
Tax classification code applied by default to the account's products, with id, name, and product_type. null when no default is set.
Account business address used to calculate tax, with line1, line2, city, state, postal_code, and country. null when no address is set.
Account tax/VAT registrations, each with id, tax_id_type, and tax_id_value. Empty when none are set.
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.
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.