Sign in
Accounts

Update Account

Updates an account. User tokens can update business accounts; business account API keys can update connected accounts.

patch/accounts/{account_id}

Path parameters

account_idstring required

Account ID, prefixed biz_.

Request body

affiliate_application_requiredboolean

Whether prospective affiliates must submit an application before promoting this account.

affiliate_instructionsstring nullable

Guidelines shown to affiliates promoting this account.

banner_imageobject nullable

Attachment input for the account banner image.

business_typestring nullable

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

collect_vat_idboolean

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

countrystring nullable

Country where the account is located.

descriptionstring nullable

Account promotional description.

featured_affiliate_product_idstring nullable

The ID of the product to feature for affiliates. Pass null to clear.

home_preferencesstring[]

Public account home page preferences.

industry_groupstring nullable

Account industry group. See the business types and industries glossary for valid values.

industry_typestring nullable

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

invoice_prefixstring nullable

Prefix used for account invoices.

logoobject nullable

Attachment input for the account logo.

metadataobject

Arbitrary key/value metadata to store on the account.

onboarding_typestring nullable

The type of onboarding the account has completed.

opengraph_imageobject nullable

Attachment input for the account Open Graph image.

opengraph_image_variantstring nullable

The account Open Graph image variant.

other_business_descriptionstring nullable

The description of the business type when business_type is other.

other_industry_descriptionstring nullable

The description of the industry type when industry_type is other.

product_tax_code_idstring nullable

ID of the tax classification code applied by default to the account's products. See the available product categories.

require_2faboolean

Whether the account requires authorized users to have two-factor authentication enabled.

routestring nullable

The unique URL slug for the account.

send_customer_emailsboolean

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

show_joined_whopsboolean

Whether the account appears in joined whops on other accounts.

show_reviews_dtcboolean

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

show_user_directoryboolean

Whether the account shows users in the user directory.

social_linksobject[]

The full list of social links to display for the account.

store_page_configobject nullable

Account store page display configuration.

target_audiencestring nullable

The target audience for this account.

tax_collection_enabled_statesstring[]

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.

tax_remitted_by'whop' | 'self' | 'none'

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.

tax_type'inclusive' | 'exclusive'

How tax is applied to the account's prices: inclusive (tax included in the listed price) or exclusive (tax added on top).

titlestring nullable

The display name of the account.

use_logo_as_opengraph_image_fallbackboolean

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

Response

account updated

banner_image_urlstring nullable required

Account banner image URL.

business_addressobject nullable required

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

business_typestring nullable required

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

collect_vat_idboolean required

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

countrystring nullable required

Country where the account is located.

created_atstring required

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

descriptionstring nullable required

Account promotional description.

emailstring nullable required

Account owner email address.

home_preferencesstring[] required
idstring required

Account ID, prefixed biz_.

industry_groupstring nullable required

Account industry group. See the business types and industries glossary for valid values.

industry_typestring nullable required

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

invoice_prefixstring nullable required

Prefix used for account invoices.

logo_urlstring nullable required

Account logo image URL.

metadataobject required

Arbitrary key/value metadata supplied at account creation.

onboarding_typestring nullable required

Type of onboarding the account has completed.

opengraph_image_urlstring nullable required

Account Open Graph image URL.

opengraph_image_variantstring nullable required

Account Open Graph image variant.

other_business_descriptionstring nullable required

Business type details when business_type is other.

other_industry_descriptionstring nullable required

Industry details when industry_type is other.

parent_account_idstring nullable required

Parent account ID for connected accounts.

product_tax_codeobject nullable required

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

require_2faboolean required

Whether authorized users must enable two-factor authentication.

routestring required

Account public route identifier.

send_customer_emailsboolean required

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

show_joined_whopsboolean required

Whether the account appears in joined whops on other accounts.

show_reviews_dtcboolean required

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

show_user_directoryboolean required

Whether the account shows users in the user directory.

statusstring nullable required

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

store_page_configobject required

Account store page display configuration.

target_audiencestring nullable required

Target audience for this account.

tax_collection_enabled_statesstring[] required
tax_remitted_bystring nullable 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.

tax_typestring nullable required

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.

titlestring required

Account display name.

total_earned_usdnumber nullable required

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

total_usdstring nullable 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_fallbackboolean required

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

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

Example response

{
  "capabilities": {
    "accept_bank_payments": "active",
    "accept_bnpl_payments": "active",
    "accept_card_payments": "active",
    "bank_deposit": "active",
    "card_deposit": "active",
    "card_issuing": "active",
    "crypto_deposit": "active",
    "crypto_payout": "active",
    "instant_payout": "active",
    "run_ads": "active",
    "standard_payout": "active",
    "transfer": "active"
  },
  "cards": {
    "kind": "individual"
  },
  "company_formation": {
    "signatures": {
      "form8821": {
        "status": "pending"
      },
      "ss4": {
        "status": "pending"
      }
    }
  },
  "recommended_actions": [
    {
      "action": "theme_business",
      "status": "optional"
    }
  ],
  "required_actions": [
    {
      "action": "deposit_funds",
      "status": "required"
    }
  ],
  "social_links": [
    {
      "website": "x"
    }
  ],
  "wallet": {
    "network": "solana"
  }
}

Changes