Create Account

curl --request POST \
  --url https://{defaultHost}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "metadata": {}
}
'

{
  "id": "<string>",
  "email": "<string>",
  "title": "<string>",
  "description": "<string>",
  "route": "<string>",
  "logo_url": "<string>",
  "banner_image_url": "<string>",
  "business_type": "<string>",
  "country": "<string>",
  "home_preferences": [
    "<string>"
  ],
  "industry_group": "<string>",
  "industry_type": "<string>",
  "invoice_prefix": "<string>",
  "onboarding_type": "<string>",
  "opengraph_image_url": "<string>",
  "opengraph_image_variant": "<string>",
  "other_business_description": "<string>",
  "other_industry_description": "<string>",
  "require_2fa": true,
  "target_audience": "<string>",
  "send_customer_emails": true,
  "show_joined_whops": true,
  "show_reviews_dtc": true,
  "show_user_directory": true,
  "store_page_config": {},
  "parent_account_id": "<string>",
  "metadata": {},
  "created_at": "<string>",
  "use_logo_as_opengraph_image_fallback": true,
  "total_earned_usd": 123,
  "status": "<string>",
  "capabilities": {
    "accept_card_payments": "active",
    "accept_bank_payments": "active",
    "accept_bnpl_payments": "active",
    "standard_payout": "active",
    "instant_payout": "active",
    "crypto_payout": "active",
    "transfer": "active",
    "bank_deposit": "active",
    "crypto_deposit": "active",
    "card_deposit": "active",
    "card_issuing": "active"
  },
  "required_actions": [
    {
      "action": "deposit_funds",
      "status": "required",
      "title": "<string>",
      "description": "<string>",
      "cta_label": "<string>",
      "cta": "<string>",
      "icon_url": "<string>",
      "blocked_capabilities": [
        "<string>"
      ]
    }
  ],
  "recommended_actions": [
    {
      "action": "apply_for_financing",
      "status": "optional",
      "title": "<string>",
      "description": "<string>",
      "cta_label": "<string>",
      "cta": "<string>",
      "icon_url": "<string>",
      "blocked_capabilities": [
        "<string>"
      ]
    }
  ],
  "tax_remitted_by": "<string>",
  "product_tax_code": {},
  "business_address": {},
  "tax_identifiers": "<array>",
  "total_usd": "<string>",
  "balances": [
    {
      "symbol": "<string>",
      "name": "<string>",
      "balance": "<string>",
      "value_usd": "<string>",
      "price_usd": 123,
      "icon_url": "<string>",
      "breakdown": {}
    }
  ],
  "verification": {},
  "wallet": {
    "id": "<string>",
    "address": "<string>",
    "network": "solana"
  },
  "social_links": [
    {
      "id": "<string>",
      "website": "x",
      "url": "<string>",
      "title": "<string>"
    }
  ]
}

POST

accounts

Create Account

curl --request POST \
  --url https://{defaultHost}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "metadata": {}
}
'

{
  "id": "<string>",
  "email": "<string>",
  "title": "<string>",
  "description": "<string>",
  "route": "<string>",
  "logo_url": "<string>",
  "banner_image_url": "<string>",
  "business_type": "<string>",
  "country": "<string>",
  "home_preferences": [
    "<string>"
  ],
  "industry_group": "<string>",
  "industry_type": "<string>",
  "invoice_prefix": "<string>",
  "onboarding_type": "<string>",
  "opengraph_image_url": "<string>",
  "opengraph_image_variant": "<string>",
  "other_business_description": "<string>",
  "other_industry_description": "<string>",
  "require_2fa": true,
  "target_audience": "<string>",
  "send_customer_emails": true,
  "show_joined_whops": true,
  "show_reviews_dtc": true,
  "show_user_directory": true,
  "store_page_config": {},
  "parent_account_id": "<string>",
  "metadata": {},
  "created_at": "<string>",
  "use_logo_as_opengraph_image_fallback": true,
  "total_earned_usd": 123,
  "status": "<string>",
  "capabilities": {
    "accept_card_payments": "active",
    "accept_bank_payments": "active",
    "accept_bnpl_payments": "active",
    "standard_payout": "active",
    "instant_payout": "active",
    "crypto_payout": "active",
    "transfer": "active",
    "bank_deposit": "active",
    "crypto_deposit": "active",
    "card_deposit": "active",
    "card_issuing": "active"
  },
  "required_actions": [
    {
      "action": "deposit_funds",
      "status": "required",
      "title": "<string>",
      "description": "<string>",
      "cta_label": "<string>",
      "cta": "<string>",
      "icon_url": "<string>",
      "blocked_capabilities": [
        "<string>"
      ]
    }
  ],
  "recommended_actions": [
    {
      "action": "apply_for_financing",
      "status": "optional",
      "title": "<string>",
      "description": "<string>",
      "cta_label": "<string>",
      "cta": "<string>",
      "icon_url": "<string>",
      "blocked_capabilities": [
        "<string>"
      ]
    }
  ],
  "tax_remitted_by": "<string>",
  "product_tax_code": {},
  "business_address": {},
  "tax_identifiers": "<array>",
  "total_usd": "<string>",
  "balances": [
    {
      "symbol": "<string>",
      "name": "<string>",
      "balance": "<string>",
      "value_usd": "<string>",
      "price_usd": 123,
      "icon_url": "<string>",
      "breakdown": {}
    }
  ],
  "verification": {},
  "wallet": {
    "id": "<string>",
    "address": "<string>",
    "network": "solana"
  },
  "social_links": [
    {
      "id": "<string>",
      "website": "x",
      "url": "<string>",
      "title": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

An account API key, account scoped JWT, app API key, or user OAuth token.

Body

application/json

string

The email address of the account owner. Required for business account API key requests.

metadata

object

Arbitrary key/value metadata to store on the account.

Response

account created

string

required

Account ID, prefixed biz_.

string | null

required

Account owner email address.

title

string

required

Account display name.

description

string | null

required

Account promotional description.

route

string

required

Account public route identifier.

logo_url

string | null

required

Account logo image URL.

banner_image_url

string | null

required

Account banner image URL.

business_type

string | null

required

High-level business category for the account.

country

string | null

required

Country where the account is located.

home_preferences

string[]

required

Public account home page preferences.

industry_group

string | null

required

Account industry group.

industry_type

string | null

required

Specific industry vertical for the account.

invoice_prefix

string | null

required

Prefix used for account invoices.

onboarding_type

string | null

required

Type of onboarding the account has completed.

opengraph_image_url

string | null

required

Account Open Graph image URL.

opengraph_image_variant

string | null

required

Account Open Graph image variant.

other_business_description

string | null

required

Business type details when business_type is other.

other_industry_description

string | null

required

Industry details when industry_type is other.

require_2fa

boolean

required

Whether authorized users must enable two-factor authentication.

target_audience

string | null

required

Target audience for this account.

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.

store_page_config

object

required

Account store page display configuration.

parent_account_id

string | null

required

Parent account ID for connected accounts.

metadata

object

required

Arbitrary key/value metadata supplied at account creation.

created_at

string

required

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

use_logo_as_opengraph_image_fallback

boolean

required

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

total_earned_usd

number | null

required

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

status

string | null

required

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

capabilities

object

required

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.

Show child attributes

required_actions

object[] | null

required

Show child attributes

recommended_actions

object[] | null

required

Show child attributes

tax_remitted_by

string | null

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.

product_tax_code

object

required

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

business_address

object

required

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

tax_identifiers

array

required

Account tax/VAT registrations, each with id, tax_id_type, and tax_id_value. Empty when none are set.

total_usd

string | null

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.

balances

object[]

required

Show child attributes

verification

object

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.

wallet

object

required

Account primary crypto wallet, or null if none has been provisioned.

Show child attributes

List Accounts

Retrieve Account

⌘I