Update Account
Updates an account. User tokens can update business accounts; business account API keys can update connected accounts.
Authorizations
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, 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.
Account business address used to calculate tax. A complete address in a supported country is required when tax_remitted_by is self.
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.
Arbitrary key/value metadata to store on the account.
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.
ID of the tax classification code applied by default to the account's products. See the available product categories.
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.
US state codes (50 states plus DC) where the account collects tax. Replaces the full set on update. Only settable when tax_remitted_by is self.
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY 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.
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 The display name of the account.
Whether the account uses its logo as the fallback Open Graph image.
Response
account updated
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.
LLC formation state for the account: a draft state with payment_pending, or the live filing state with registration progress, documents, and pending signatures.
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.
Payment health controls currently applied to the account. Computed only on retrieve and me for callers with company:balance:read scope; null otherwise.
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.
Whether authorized users must enable two-factor authentication.
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.
Whether 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.
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).
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.