c301132dbfd7
Update Account
Updates an account. User tokens can update business accounts; Account API keys can update connected accounts.
Path parameters
Account ID, prefixed biz_.
Request body
Whether prospective affiliates must submit an application before promoting this account.
Guidelines shown to affiliates promoting this account.
The legal business name used with the account's tax address.
High-level business category for the account. See the business types and industries glossary for valid values.
Whether checkout shows a VAT/tax ID field for buyers to optionally enter. Does not require a VAT ID to purchase.
Country where the account is located.
Account promotional description. When creating a Whop-managed Facebook page, it is truncated to 155 characters and used as the About text.
The ID of the product to feature for affiliates. Pass null to clear.
Public account home page preferences.
Account industry group. See the business types and industries glossary for valid values.
Specific industry vertical for the account. See the business types and industries glossary for valid values.
Prefix used for account invoices.
Arbitrary key/value metadata to store on the account.
The type of onboarding the account has completed.
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.
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.
Determines whether Whop or the account calculates and remits tax. The account must provide a supported-country business address when it self-remits.
Determines whether tax is included in the listed price or added at checkout.
Account-level 3D Secure behavior. Set mandate_challenge to require cardholder verification on supported card payments, or null to use the standard checkout flow.
The display name of the account.
Whether the account uses its logo as the fallback Open Graph image.
Example request
{
"affiliate_application_required": true,
"affiliate_instructions": "Send us your detailing content before promoting. No paid search on our brand terms.",
"banner_image": {
"id": "file_xxxxxxxxxxxxxx"
},
"business_address": {
"city": "Austin",
"country": "US",
"line1": "4180 Burnet Rd",
"line2": "Suite 2",
"postal_code": "78756",
"state": "TX"
},
"business_name": " Shine Time Auto Detailing, LLC ",
"business_type": "other",
"collect_vat_id": true,
"country": "US",
"description": "Mobile ceramic coating, paint correction, and interior detailing across the Austin metro.",
"featured_affiliate_product_id": "prod_xxxxxxxxxxxxxx",
"home_preferences": [
"hide_member_count"
],
"industry_group": "automotive",
"industry_type": "other",
"invoice_prefix": "SHINE",
"logo": {
"id": "file_xxxxxxxxxxxxxx"
},
"metadata": {
"external_id": "shop_4417",
"region": "austin"
},
"onboarding_type": "seller",
"opengraph_image": {
"id": "file_xxxxxxxxxxxxxx"
},
"opengraph_image_variant": "black",
"other_business_description": "Mobile auto detailing",
"other_industry_description": "Automotive services",
"product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
"require_2fa": true,
"route": "shine-time-detailing",
"social_links": [
{
"url": "https://instagram.com/shinetimedetail",
"website": "instagram"
}
],
"store_page_config": {
"accent_color": "red",
"layout": "compact",
"profile_variant": "business",
"whop_affiliate_link": true
},
"target_audience": "Owners of new and enthusiast vehicles in Austin, TX",
"tax_collection_enabled_states": [
"TX"
],
"tax_identifiers": [
{
"tax_id_type": "eu_vat",
"tax_id_value": "DE123456789"
}
],
"tax_remitted_by": "self",
"tax_type": "inclusive",
"three_ds_level": "mandate_challenge",
"title": "Shine Time Auto Detailing",
"use_logo_as_opengraph_image_fallback": true
}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.
The account's legal business name used with its tax address.
High-level business category for the account. See the business types and industries glossary for valid values.
Whether pending funds may be transferred from this platform account to its connected accounts.
Whether checkout shows a VAT/tax ID field for buyers to optionally enter. Does not require a VAT ID to purchase.
Country where the account is located.
When the account was created, as an ISO 8601 timestamp.
Account promotional description.
Account owner email address.
Account ID, prefixed biz_.
Account industry group. See the business types and industries glossary for valid values.
Specific industry vertical for the account. See the business types and industries glossary for valid values.
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.
Tax classification code applied by default to the account's products, with id, name, and product_type. null when no default is set.
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 settles on stablecoin rails — its balance is held on-chain as USDT and paid out over crypto, rather than as fiat cash.
Whether the account can operate on Whop: active or suspended. Computed on list, retrieve, and me; null otherwise.
Why the account was suspended, in language safe to show the account owner. Computed only on retrieve and me; null otherwise, when status is not suspended, and when the suspension was recorded without a reason.
Target audience for this 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). null until the account enrolls in the Whop tax service.
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.
Account-level 3D Secure behavior. mandate_challenge requires cardholder verification on supported card payments; null uses the standard checkout flow.
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, manual_review, approved, or rejected.
Lifetime volume through the account — sales plus transfers received — normalized to USD. Computed only on list for callers with stats:read on the account; null otherwise.
Example response
{
"balances": [
{
"balance": "50.0",
"breakdown": {
"available": "1500.0",
"in_transit": "0",
"pending": "0",
"pending_settlements": [
{
"amount": "12.5",
"date": "2026-01-01"
}
],
"reserve": "0"
},
"icon_url": "https://assets.whop.com/tokens/usd.png",
"name": "US Dollar",
"price_usd": 1,
"symbol": "USD",
"value_usd": "50.00"
}
],
"banner_image_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"business_address": {
"city": "Austin",
"country": "US",
"line1": "4180 Burnet Rd",
"line2": "Suite 2",
"postal_code": "78756",
"state": "TX"
},
"business_name": "Shine Time Auto Detailing, LLC",
"business_type": "other",
"capabilities": {
"accept_bank_payments": "active",
"accept_bnpl_payments": "inactive",
"accept_card_payments": "active",
"bank_deposit": "inactive",
"card_deposit": "active",
"card_issuing": "inactive",
"crypto_deposit": "active",
"crypto_payout": "inactive",
"instant_payout": "inactive",
"run_ads": "active",
"standard_payout": "inactive",
"transfer": "inactive"
},
"cards": {
"kind": "individual",
"status": "approved"
},
"collect_vat_id": true,
"company_formation": {
"documents": [
{
"id": "file_xxxxxxxxxxxxxx",
"name": "Articles of Organization",
"type": "articles_of_organization",
"url": "https://assets-2-rough.whop.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
],
"legal_name": "Shine Time Auto Detailing, LLC",
"signatures": {
"form8821": {
"expires_at": "2026-01-01T12:00:00.000Z",
"status": "pending",
"url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
},
"ss4": {
"expires_at": "2026-01-01T12:00:00.000Z",
"status": "pending",
"url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
}
},
"state_registered": true
},
"country": "us",
"created_at": "2026-01-01T12:00:00.000Z",
"description": "Mobile ceramic coating, paint correction, and interior detailing across the Austin metro.",
"email": "marcus@shinetime.example",
"home_preferences": [
"hide_member_count"
],
"id": "biz_xxxxxxxxxxxxxx",
"industry_group": "automotive",
"industry_type": "other",
"invoice_prefix": "SHINE",
"logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"metadata": {
"external_id": "shop_4417",
"region": "austin"
},
"onboarding_type": "seller",
"opengraph_image_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"opengraph_image_variant": "black",
"other_business_description": "Mobile auto detailing",
"other_industry_description": "Automotive services",
"owner": {
"id": "user_xxxxxxxxxxxxxx",
"name": "Dana Whitfield",
"profile_picture": {
"url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"username": "danawhitfield"
},
"parent_account": {
"id": "biz_xxxxxxxxxxxxxx",
"logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"route": "shine-time-holdings",
"title": "Shine Time Holdings"
},
"payment_controls": {
"dispute_alert_auto_refund": {
"threshold_usd": 500
},
"dispute_alert_fee_usd": 29,
"pending_auto_topup_fee_percentage": 2,
"reserve": {
"hold_period_days": 14,
"percentage": 15
},
"resolution_center_auto_refund": {
"card_threshold_usd": 50,
"financing_threshold_usd": 25,
"paypal_threshold_usd": 40
},
"restricted_payment_methods": [
"card_visa"
]
},
"product_tax_code": {
"id": "ptc_xxxxxxxxxxxxxx",
"name": "General - Digital Goods",
"product_type": "digital"
},
"recommended_actions": [
{
"action": "apply_for_financing",
"blocked_capabilities": [
"accept_bnpl_payments"
],
"cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/settings/payments/",
"cta_label": "Apply",
"description": "Let customers pay over time with buy now, pay later.",
"icon_url": "https://whop.com/illustrations/orange/piggy-bank.svg",
"impact_score": 86,
"reasoning": "Financing lifts conversion on the $249 ceramic coating, the priciest job on the menu.",
"status": "optional",
"title": "Offer financing at checkout"
}
],
"require_2fa": true,
"required_actions": [
{
"action": "verify_identity",
"blocked_capabilities": [
"standard_payout"
],
"cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/balance/",
"cta_label": "Verify now",
"description": "Complete verification to withdraw your earnings.",
"icon_url": "https://whop.com/illustrations/orange/shield.svg",
"status": "required",
"title": "Complete your identity verification"
}
],
"route": "biz_xxxxxxxxxxxxxx",
"social_links": [
{
"id": "social_1",
"title": "@shinetimedetail",
"url": "https://instagram.com/shinetimedetail",
"website": "instagram"
}
],
"status": "active",
"status_reason": "Payments are paused while we review recent chargebacks on this account.",
"store_page_config": {
"accent_color": "red",
"layout": "compact",
"profile_variant": "business",
"whop_affiliate_link": true
},
"target_audience": "Owners of new and enthusiast vehicles in Austin, TX",
"tax_collection_enabled_states": [
"TX"
],
"tax_identifiers": [
{
"id": "txid_xxxxxxxxxxxxxx",
"tax_id_type": "eu_vat",
"tax_id_value": "DE123456789"
}
],
"tax_remitted_by": "self",
"tax_type": "inclusive",
"three_ds_level": "mandate_challenge",
"title": "Shine Time Auto Detailing",
"total_usd": "50.00",
"use_logo_as_opengraph_image_fallback": true,
"verification": {
"business": null,
"individual": null
},
"wallet": {
"address": "0xabc123",
"id": "cwal_xxxxxxxxxxxxxx",
"network": "ethereum"
}
}