Skip to main content
An Account represents a person or business in Whop. Each account has its own profile, wallet, and settings, so you can create one for every customer, creator, merchant, or seller your integration supports. Create an account when someone needs to hold funds, receive payments, send money, or use account-scoped API features. Save the returned id and wallet details, and use metadata to store your own stable identifier, like a user ID from your system.

​
Endpoints

EndpointRequest
Create AccountPOST /accounts
Update AccountPATCH /accounts/{account_id}
Retrieve AccountGET /accounts/{account_id}
Retrieve Requesting AccountGET /accounts/me
List AccountsGET /accounts

​
Attributes

​
banner_image_url
string | null
required
The URL of the account banner image
​
business_type
string | null
required
The high-level business category for the account
​
country
string | null
required
The country the account is located in
​
created_at
string
required
When the account was created, as an ISO 8601 timestamp
​
description
string | null
required
A promotional description for the account
​
email
string | null
required
The email address of the account owner
​
home_preferences
string[]
required
​
id
string
required
The ID of the account, which will look like biz_*************
​
industry_group
string | null
required
The industry group the account belongs to
​
industry_type
string | null
required
The specific industry vertical the account operates in
​
invoice_prefix
string | null
required
The prefix used for account invoices
​
logo_url
string | null
required
The URL of the account logo image
​
metadata
object
required
Arbitrary key/value metadata supplied when the account was created
​
onboarding_type
string | null
required
The type of onboarding the account has completed
​
opengraph_image_url
string | null
required
The URL of the account Open Graph image
​
opengraph_image_variant
string | null
required
The account Open Graph image variant
​
other_business_description
string | null
required
The description of the business type when business_type is other
​
other_industry_description
string | null
required
The description of the industry type when industry_type is other
​
parent_account_id
string | null
required
The parent account ID for connected accounts
​
require_2fa
boolean
required
Whether the account requires authorized users to have two-factor authentication enabled
​
route
string
required
The account’s public route identifier
​
send_customer_emails
boolean
required
Whether Whop sends transactional emails to customers on behalf of this account
​
show_joined_whops
boolean
required
Whether the account appears in joined whops on other accounts
​
show_reviews_dtc
boolean
required
Whether reviews are displayed on direct-to-consumer product pages
​
show_user_directory
boolean
required
Whether the account shows users in the user directory
​
social_links
object[]
required

Properties

​
id
string
required
The ID of the social link
​
title
string | null
required
The optional display title for the social link
​
url
string
required
The social link URL
​
website
string
required
The social platform for this linkAvailable options: x, instagram, facebook, tiktok, youtube, linkedin, twitch, website, custom
​
store_page_config
object
required
Store page display configuration for the account
​
target_audience
string | null
required
The target audience for this account
​
title
string
required
The display name of the account
​
use_logo_as_opengraph_image_fallback
boolean
required
Whether the account uses its logo as the fallback Open Graph image
​
wallet
object | null
required
The account’s primary crypto wallet, or null if none has been provisioned

Properties

​
address
string
required
The on-chain address of the wallet
​
id
string
required
The ID of the wallet, which will look like wallet_*************
​
network
string
required
The blockchain network the wallet lives onAvailable options: solana, ethereum, bitcoin
Account
{
	"banner_image_url": "https://cdn.whop.com/banner.png",
	"business_type": "flower_delivery",
	"country": "US",
	"created_at": "2026-06-01T12:00:00Z",
	"description": "Petal Post delivers fresh bouquets.",
	"email": "hello@petalpost.example",
	"home_preferences": ["storefront"],
	"id": "biz_petalpost123",
	"industry_group": "commerce",
	"industry_type": "flower_delivery",
	"invoice_prefix": "PETAL",
	"logo_url": "https://cdn.whop.com/logo.png",
	"metadata": {
		"external_merchant_id": "merchant_123"
	},
	"onboarding_type": "standard",
	"opengraph_image_url": "https://cdn.whop.com/og.png",
	"opengraph_image_variant": "banner",
	"other_business_description": "Local flower delivery",
	"other_industry_description": "Same-day floral gifts",
	"parent_account_id": "biz_platform123",
	"require_2fa": true,
	"route": "petal-post",
	"send_customer_emails": true,
	"show_joined_whops": false,
	"show_reviews_dtc": true,
	"show_user_directory": false,
	"social_links": [
		{
			"id": "social_petalpost123",
			"title": "Petal Post",
			"url": "https://petalpost.example",
			"website": "website"
		}
	],
	"store_page_config": {
		"theme": "floral"
	},
	"target_audience": "Customers sending flowers locally",
	"title": "Petal Post",
	"use_logo_as_opengraph_image_fallback": true,
	"wallet": {
		"address": "So11111111111111111111111111111111111111112",
		"id": "wallet_petalpost123",
		"network": "solana"
	}
}