> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # List Accounts > Lists accounts visible to the credential. User tokens return the user's business accounts; Account API keys return the requesting account and its connected accounts. Pass `parent_account_id` to return only that parent account's connected accounts. ## OpenAPI ````yaml /openapi/api-v1-native.json get /accounts openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: > An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports. Use the Accounts API to create accounts, list accounts visible to your credentials, retrieve or update an account, and retrieve the account associated with the current API key. name: Accounts x-whop-summary: 'A business on Whop: profile, wallet, capabilities, settings.' - description: > A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience. name: Users x-whop-summary: 'A person on Whop: profile and connected identities.' - description: > A Team Member is a member of an account's team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like `admin` or `moderator`) or `custom` roles managed from the dashboard. Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead. name: Team Members x-whop-summary: An account's team members and the roles that scope their access. - description: > A Member is one buyer's relationship with an account — one record per customer regardless of how many memberships they hold. It carries relationship-level state: whether they have joined or left, their access level (`customer`, `admin`, or `no_access`), when they joined, and when they last opened the account's content. Use the Members API to list an account's members with filtering by access level, status, join date, and name or username search, and to retrieve a single member. Member rows are created and maintained by the membership lifecycle; to grant or revoke access, work with memberships instead. name: Members x-whop-summary: One buyer's relationship with an account, across all their purchases. - name: Webhooks x-whop-summary: Event notifications pushed to your server as things happen. - description: > Stats represent aggregated activity for an account over time. They help you understand revenue, transactions, disputes, members, referrals, and advertising performance across reporting periods like days, weeks, or months. Use the Stats API to list available metrics and their filterable properties, then retrieve time-series values for a date range. name: Stats x-whop-summary: Aggregated financial, audience, and traffic reporting. - description: > A Verification represents a legal identity for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](/api-reference/beta/verifications/update-verification). name: Verifications x-whop-summary: Legal identity required before payouts and card issuing. - description: > An Export is an asynchronous CSV of one resource for one account — members, payments, disputes, ads, and the other tables the Whop dashboard can export. Generating a full table takes longer than a request, so an export is created in `pending`, moves through `processing`, and lands on `completed` with a download link. Each resource requires that resource's own export scope. Use the Exports API to start an export, poll it until `download_url` is set, and list the exports already requested for an account. Finished CSVs are retained for 30 days, after which the file is deleted and the export moves to `expired`. name: Exports x-whop-summary: Asynchronous CSV dumps of an account's dashboard data. - description: > A Notification is a message delivered to a user — a new post, a payment, a mention. Every notification comes from an experience the user belongs to or a team they are on, and users control what they receive with notification preferences. Every notification belongs to a topic: the category it falls under, such as new sales or account activity. Topics carry a default, so a user only needs a preference row where they diverge from it. `GET /notifications/topics` lists the platform's visible topics, and a topic's `id` is what the notification preference endpoints take as `topic_id` — the catalog is the only place those ids come from, so read it rather than hardcoding. Each topic also carries an `identifier` such as `new-follower`, which is stable across environments and is the value to match on in code. Use the Notifications API to list the authenticated user's feed, read per-experience unread badges, mark an experience (or everything) as read, send notifications from your app to an experience's users or an account's team, and list the topic catalog. name: Notifications x-whop-summary: >- The user's notification feed: unread badges, mark-read, app sends, and the topic catalog. - description: > A Payment is one charge against a buyer. Create it with a payment method already on file, or with a `confirmation_token` describing a method the buyer has just supplied. Collection runs in the background, so the create response is not the outcome. Poll [Retrieve status](/api-reference/beta/payments/retrieve-status) for how far the payment has got and, while it is `requires_action`, what the buyer must do next — follow a redirect, complete 3D Secure, display transfer instructions, or link a bank account. Use the return_url operation to change where they land afterwards, up until they come back. name: Payments x-whop-summary: A charge against a buyer, and the step they still owe. - description: > A Setup Intent saves a buyer's payment method for later without taking money now. It runs the same collection flow a payment does, so the buyer may still owe a step — 3D Secure on a card, a hosted enrollment, or linking a bank account. Poll [Retrieve status](/api-reference/beta/setup-intents/retrieve-status) for how far the setup has got and what is outstanding. Once it reaches `succeeded` the method is on file and can be charged. name: Setup Intents x-whop-summary: Saving a buyer's payment method without charging it. - description: > A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable. name: Ledgers x-whop-summary: The activity feed behind an account or user's balance. - description: > Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create and track payouts, manage saved payout methods, and show expected arrival details for funds leaving Whop. name: Payouts x-whop-summary: Send money from a balance to a bank or wallet. - description: > Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - description: > A Dispute is a chargeback a customer files against a payment through their bank, or an inquiry that may become one. It carries the disputed payment, a deadline to respond, your evidence, and the outcome once the processor rules. Use the Disputes API to list disputes, edit the evidence packet while a dispute is still contestable, and submit it for review. name: Disputes x-whop-summary: Chargebacks filed against an account, with evidence and outcomes. - description: > A Dispute alert is an early warning from a card issuer that a settled payment is being questioned, ahead of any chargeback. `type` separates fraud reports (`early_fraud_warning`), pre-dispute notices (`dispute_alert`), and Visa RDR cases the network already closed by refunding (`rapid_dispute_resolution`). Use the Dispute alerts API to list alerts for an account, filter them by type or payment, and read `actionable` to see whether refunding can still avoid the chargeback. name: Dispute alerts x-whop-summary: Issuer warnings that arrive before a chargeback does. - description: > Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account. name: Deposits x-whop-summary: Add funds to a balance. - description: > Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap. Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Resolution Center Case is opened by a buyer when something is wrong with a purchase — an unwanted renewal, an item that never arrived, or a charge they don't recognize. It is the step before a chargeback: the two sides work it out directly, and Whop decides the case if they can't. Each case carries a reason, a status naming which side it is waiting on, a timeline of events, and the actions available to whoever is reading it. Use the Resolution Center Cases API from either side: as the buyer, open a case, reply, appeal a decision, or withdraw it; as the merchant, accept it (refunding the payment), deny it, or ask the buyer for more information. Both sides read the same case, page its timeline, and summarize the cases they can see. name: Resolution Center Cases x-whop-summary: File or respond to a case against a payment, as the buyer or the merchant. - description: > A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold. name: Products x-whop-summary: The things you sell. Each owns plans and a store page. - description: > A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility. Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered. name: Plans x-whop-summary: 'Pricing for a product: one-time, recurring, trials, stock.' - name: Promo Codes x-whop-summary: Discounts that creators configure for checkout. - description: > A Membership is a customer's purchase of a plan: the subscription or one-time grant that gives them access to a product. It tracks billing state (`active`, `trialing`, `past_due`, and so on), the current period, pending cancellations, custom metadata, and the software license key when the product includes licensing. Use the Memberships API to list an account's memberships or the caller's own, retrieve one by ID or license key, invite a recipient to join through a free plan, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled period-end cancellation, pause and resume payment collection, extend with free days, generate a transfer link, and update metadata. name: Memberships x-whop-summary: A customer's purchase of a plan, from checkout through cancellation. - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used. name: Checkout Configurations x-whop-summary: Turn a plan into a shareable, prefilled checkout link. - description: > A Payment Method Domain registers a hostname with a wallet provider so its payment methods can appear at a checkout served from that domain. The domain proves ownership by hosting the provider's association file — for Apple Pay, at `/.well-known/apple-developer-merchantid-domain-association` — and `status` reports whether verification has completed. Use the Payment Method Domains API to register domains for your account or its connected accounts, retry verification once the association file is hosted, and remove domains that should no longer serve wallet payments. A domain a platform shares with its connected accounts at checkout is listed on the platform's account, not on each connected account. name: Payment Method Domains x-whop-summary: >- Domains verified to show wallet payment methods like Apple Pay at checkout. - description: > A Shipment attaches a carrier tracking number to a payment and follows the package from label creation to delivery, exposing the current delivery status and a customer-facing tracking URL. Use the Shipments API to list an account's shipments, retrieve one by its id or the payment it fulfills, attach a tracking number to a payment, and update the tracking number on an existing shipment. name: Shipments x-whop-summary: Track the delivery of an order by its carrier tracking number. - description: > The Partners API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard. Use it to enroll as a Whop partner, list the users you referred, list your referred businesses and review their earnings, and see the partner leaderboard. name: Partners x-whop-summary: >- The users and businesses you referred to Whop, and what you earn from them. - description: > A Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills. Use the Bounties API to create and publish a bounty, list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID. name: Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - description: > A Bounty Submission is one worker's attempt on a bounty. It starts as an in-progress attempt, enters the review queue when proof is submitted, and ends approved (paid from the bounty's escrowed pool) or denied. Use the Bounty Submissions API to submit proof of completed work to a bounty, list the submissions you authored, and review the submissions on your bounties — across every bounty or narrowed to one. name: Bounty Submissions x-whop-summary: Work submitted to a bounty, from attempt to payout. - description: > A Person is an identity-linked profile of a visitor or customer of an account, assembled from every [event](/api-reference/beta/events/event) the person generated — pixel page views, ad clicks, leads, identifies, and payments. Each profile carries the person's known identities (names, emails, phones, user IDs), purchase history and LTV, geo/device profile, traffic sources, and the first and last marketing touches that reached them. Use the People API to list and segment the people of an account — filter by activity, purchases, traffic source, location, or marketing touch, and sort by value — or retrieve one person by person ID, user ID, email address, or phone number. name: People x-whop-summary: >- Visitors and customers of an account, with identity, purchase, and traffic profiles. - description: > An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it. Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person. The resource also exposes an anonymized read mode — the pulse feed — a platform-wide snapshot of recent purchases that carries nothing identifying. The pulse feed is public; other Events endpoints require authentication and are scoped to an account. Events are only as good as the pixel sending them, so [Validate Pixel](/api-reference/beta/events/validate-pixel) answers whether an account's pixel is working: it reads the events the pixel has sent, and when you pass a `url` whose page hasn't sent any lately, it fetches that page and looks for the pixel in its source. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > A Recommended Action Chain is a short, ordered sequence of dashboard actions — create a product, price it, publish it — suggested for an account based on what it already has. Seeded chains come from hand-written presets; generated chains, produced per account, share the same shape. Use the Recommended Actions API to list the chains recommended for an account and to record that a chain was run. Running a chain executes nothing server-side — the client follows each step's CTA itself; the run endpoint records the `recommended_action_chain.executed` analytics event. name: Recommended Actions x-whop-summary: Suggested next-step action chains for an account. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery. name: Ads x-whop-summary: 'The creative: copy, assets, and destination URL.' - description: > An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/ad-groups/ad-group) and ads. Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery. name: Ad Campaigns x-whop-summary: Platform, objective, and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads. Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. It can also search the ad platform's targeting taxonomy for options to target and estimate how many people a draft targeting spec can reach. name: Ad Groups x-whop-summary: Audience, placements, and schedule within a campaign. - description: > An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences. Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - description: > A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files. Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready. name: Media x-whop-summary: >- AI-generated assets, billed from a balance, attachable wherever files are accepted. - description: > A Social Account represents an external profile connected to a Whop account or user, such as a Facebook page or Instagram account. Connecting a social account lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity and promote its existing posts. Use the Social Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect a social account, and list a connected profile's posts or a Facebook page's lead forms. name: Social Accounts x-whop-summary: Connected Facebook and Instagram accounts that run ads. - description: > An App is software you build on Whop. It can be a hosted web app served at `.whop.app` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. Use the Apps API to manage app configuration, deploy an app's working copy and follow the run on the app's `deployment` field, and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text. name: Apps x-whop-summary: 'Apps you build on Whop: metadata, hosted builds, runtime logs.' - description: > An App Build is a versioned artifact uploaded for an app — a hosted web archive, or an iOS/Android bundle. Builds start as drafts, go through review, and one approved build per platform is served to users as the production build. Use the App Builds API to upload a build for an app, list an app's builds with platform and status filters, retrieve a build, and promote a draft or approved build to production. name: App Builds x-whop-summary: Versioned build artifacts deployed to an app's platforms. - description: > An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist. Use the API Keys API to list an account or app's keys, create a key (the full secret is returned once, on creation), inspect a key's effective grants, update its name or restrictions, rotate its secret, and revoke it. These endpoints require a user session — they cannot be called with an API key. name: API Keys x-whop-summary: Programmatic credentials for an account or app. - description: > A Permission is one action, such as `stats:read`, paired with whether your credential is granted it on a given resource. It answers for whatever you authenticated with, so you can decide what to show or attempt instead of discovering a `403`. Use the Permissions API to check an account, product, experience, or app, narrowing to the actions you care about. It reports only your own access — to manage who else can reach an account, use the Team Members API. name: Permissions x-whop-summary: What your credential is allowed to do on a resource. paths: /accounts: parameters: - $ref: '#/components/parameters/ApiVersionDate' get: tags: - Accounts summary: List Accounts description: >- Lists accounts visible to the credential. User tokens return the user's business accounts; Account API keys return the requesting account and its connected accounts. Pass `parent_account_id` to return only that parent account's connected accounts. operationId: listAccounts parameters: - description: The number of accounts to return (default 10, max 50). in: query name: first required: false schema: type: integer - description: A cursor; returns accounts after this position. in: query name: after required: false schema: type: string - description: The number of accounts to return from the end of the range. in: query name: last required: false schema: type: integer - description: A cursor; returns accounts before this position. in: query name: before required: false schema: type: string - description: >- The field to sort accounts by. `volume` requires `stats:read` on the parent account. in: query name: order required: false schema: default: created_at enum: - created_at - volume type: string - description: Sort direction. in: query name: direction required: false schema: default: desc enum: - asc - desc type: string - description: >- Return only accounts with this status: `active` (includes accounts that have not entered payments review) or `suspended`. in: query name: status required: false schema: enum: - active - suspended type: string - description: >- Free-text filter on account title or ID. `%` and `_` match literally. in: query name: query required: false schema: type: string - description: Return only accounts created after this ISO 8601 timestamp. in: query name: created_after required: false schema: format: date-time type: string - description: Return only accounts created before this ISO 8601 timestamp. in: query name: created_before required: false schema: format: date-time type: string - description: >- Return only accounts whose lifetime USD volume is at least this value. Requires `stats:read` on the parent account. in: query name: volume_min required: false schema: type: number - description: >- Return only accounts whose lifetime USD volume is at most this value. Requires `stats:read` on the parent account. in: query name: volume_max required: false schema: type: number - description: >- For platforms: the parent account ID whose direct connected accounts to return. Requires `payout:account:read` on the parent account. in: query name: parent_account_id required: false schema: type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Account' type: array page_info: properties: end_cursor: example: WyJjdXJzb3IiLDFd type: - string - 'null' has_next_page: example: false type: boolean has_previous_page: example: false type: boolean start_cursor: example: WyJjdXJzb3IiLDFd type: - string - 'null' required: - end_cursor - start_cursor - has_next_page - has_previous_page type: object required: - data - page_info type: object description: accounts listed '400': $ref: '#/components/responses/InvalidParameters' description: invalid list parameters '401': $ref: '#/components/responses/Unauthorized' description: missing or invalid authentication '403': $ref: '#/components/responses/Forbidden' description: credential lacks the required balance-read scope security: - bearerAuth: [] - bearerAuth: - company:balance:read x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const account of client.accounts.list()) { console.log(account.id); } components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: '2026-08-21' type: string schemas: Account: properties: balances: items: $ref: '#/components/schemas/AccountBalanceToken' description: >- Account holdings, each with USD value. Empty when `total_usd` is `null`. type: array banner_image_url: description: Account banner image URL. example: >- https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: - string - 'null' business_address: description: >- Account business address used to calculate tax, with `line1`, `line2`, `city`, `state`, `postal_code`, and `country`. `null` when no address is set. example: city: Austin country: US line1: 4180 Burnet Rd line2: Suite 2 postal_code: '78756' state: TX type: - object - 'null' business_name: description: The account's legal business name used with its tax address. example: Shine Time Auto Detailing, LLC maxLength: 255 type: - string - 'null' business_type: description: >- High-level business category for the account. See the [business types and industries glossary](/api-reference/beta/accounts/account#business-types-and-industries-glossary) for valid values. enum: - education_program - coaching - software - paid_group - newsletter - agency - physical_products - brick_and_mortar - events - coaching_and_courses - other - services - gig_economy - marketplace - telehealth - class_action_settlement - physical_product - saas - course - community - null example: other type: - string - 'null' x-whop-hide-enum-values: true can_transfer_pending_balance_to_children: description: >- Whether pending funds may be transferred from this platform account to its connected accounts. example: false type: boolean capabilities: description: >- 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. oneOf: - $ref: '#/components/schemas/AccountCapabilities' - type: 'null' cards: description: >- Whop Cards application details for the account. Computed only on `retrieve` and `me` for callers with `company:balance:read` scope; `null` otherwise, or when the account has no card application. oneOf: - $ref: '#/components/schemas/AccountCards' - type: 'null' collect_vat_id: description: >- Whether checkout shows a VAT/tax ID field for buyers to optionally enter. Does not require a VAT ID to purchase. example: true type: boolean company_formation: $ref: '#/components/schemas/AccountCompanyFormation' description: >- Company formation state for the account, managed through [Form Company](/api-reference/beta/accounts/form-company). A `draft` `status` until the formation checkout is paid, then filing progress with downloadable documents and signatures awaiting action. Empty when the formation state is temporarily unavailable. country: description: Country where the account is located. example: us type: - string - 'null' created_at: description: When the account was created, as an ISO 8601 timestamp. example: '2026-01-01T12:00:00.000Z' type: string description: description: Account promotional description. example: >- Mobile ceramic coating, paint correction, and interior detailing across the Austin metro. type: - string - 'null' email: description: Account owner email address. example: marcus@shinetime.example type: - string - 'null' home_preferences: items: description: Public account home page preferences. enum: - hide_member_count - hide_members_card example: hide_member_count type: string type: array id: description: Account ID, prefixed `biz_`. example: biz_xxxxxxxxxxxxxx type: string industry_group: description: >- Account industry group. See the [business types and industries glossary](/api-reference/beta/accounts/account#business-types-and-industries-glossary) for valid values. enum: - academic_and_test_prep - accessories - agriculture_and_farming - ai_and_automation_agencies - ai_and_automation_software - arts_and_crafts - automotive - b2b_and_professional_marketplaces - baby_and_kids - bars_and_breweries - beauty_and_personal_care - beauty_and_wellness - business_and_entrepreneurship - business_and_money_groups - cafes_and_quick_service - career_and_professional - charity_and_cause_events - class_action_settlement - clothing_and_apparel - communication_and_messaging_software - community_and_education_software - conference_and_expo_events - consulting - content_and_clipping_agencies - creative_and_content_creation - creative_and_content_groups - creative_and_education - creative_gigs - creative_services - customer_support_agencies - dating_and_relationships - delivery_and_logistics - dental_and_vision - dermatology_and_skin - design_and_creative_agencies - developer_and_technical_tools - development_agencies - digital_and_education_marketplaces - digital_goods_and_accounts - e_commerce_software - education_and_childcare - educational_training_events - electronics_and_gadgets - entertainment_and_leisure - family_and_community_events - finance_and_investing - fitness_and_athletics - fitness_and_health_groups - fitness_and_recreation - fitness_equipment_and_gear - food_and_beverages - food_and_hospitality_marketplaces - funeral_and_death_care - gaming_and_entertainment_software - gaming_groups - genetic_and_specialized - government_and_public - health_and_wellness - health_and_wellness_services - healthcare - healthcare_and_wellness_software - hobbies_and_lifestyle - hobby_and_interest_groups - home_and_living - home_and_trade_services - home_and_trade_storefronts - home_improvement_and_tools - home_services_gigs - hospitality_and_lodging - industrial_and_manufacturing - industry_specific_software - language_and_communication - legal_and_compliance - lifestyle_and_culture - lifestyle_and_personal_growth - lifestyle_and_personal_growth_groups - lifestyle_and_wellness_events - logistics_and_transportation_services - marketing_agencies - marketing_and_advertising - marketing_and_sales_software - media_and_publishing_companies - mental_health_and_behavioral - miscellaneous - music_and_performing_arts - news_and_politics - nonprofit_and_charity - office_and_business_supplies - outdoor_and_sports - performance_and_show_events - personal_development - personal_finance - personal_services - pet_services - pets_and_animals - primary_and_general_care - product_marketplaces - productivity_and_business_ops - professional_gigs - professional_services - professional_services_storefront - publishing_and_info_products - real_estate - real_estate_software - recruiting_and_staffing - rehabilitation_and_therapy - religion_and_faith - rental_marketplaces - restaurants - retail - sales_agencies - sales_and_revenue - security_and_investigations - security_and_privacy_software - service_marketplaces - sleep_and_chronic_conditions - social_and_networking_events - social_entertainment_events - specialized_gigs - specialty_medical_care - spirituality_and_mindfulness - spirituality_and_personal_growth - sports_and_fitness_events - sports_betting_and_gambling - sports_betting_groups - supplements_and_nutrition - sustainability_and_eco_products - task_and_errands - tech_and_ai - tech_and_dev_groups - tech_and_development - trading_and_finance_software - trading_and_investing - trading_and_investing_groups - transportation - veterinary - video_games_and_esports - weight_and_metabolic_health - wellness_and_alternative - womens_and_mens_health - null example: automotive type: - string - 'null' x-whop-hide-enum-values: true industry_type: description: >- Specific industry vertical for the account. See the [business types and industries glossary](/api-reference/beta/accounts/account#business-types-and-industries-glossary) for valid values. enum: - trading - sports_betting - reselling - fitness - amazon_fba - real_estate - kindle_book_publishing - dating - agencies - health_and_wellness - social_media - sales - business - ecommerce - video_games - home_services - ai - public_speaking - personal_finance - careers - travel - clipping - spirituality - vas - personal_development - software - other - marketing_agency - sales_agency - ai_agency - design_agency - coaching_agency - development_agency - recruiting_agency - customer_support_agency - clipping_agency - clothing - supplements - beauty_and_personal_care - fitness_gear - accessories - home_goods - electronics_and_gadgets - food_and_beverages - gym - restaurant - retail_store - coffee_shop - salon_spa - medical_dentist_office - hotel_lodging - auto_repair_shop - masterminds - webinars - bootcamps - convention - concerts - meetups - parties - forex_trading - stock_trading - options_trading - crypto_trading - futures_trading - day_trading - swing_trading - algorithmic_trading - prop_firm_trading - value_investing - real_estate_investing - alternative_investments - penny_stock_trading - dividend_investing - index_fund_investing - gold_precious_metals - venture_capital_education - private_equity_education - technical_analysis - forex_scalping - ict_smc_trading - personalized_investment_advice - forex_signals_group - stock_signals_group - crypto_signals_group - options_alerts_group - futures_signals_group - trading_education_group - investing_community - prediction_markets_group - nft_alpha_group - penny_stock_group - dividend_investing_group - real_estate_investing_group - prop_firm_group - forex_trading_bot - stock_trading_platform - crypto_trading_bot - futures_trading_bot - options_flow_tool - portfolio_tracker - financial_modeling_software - accounting_software - invoicing_software - tax_software - risk_management_software - prop_trading_platform - backtesting_software - trading_indicators - market_data_feed - stock_research_tool - banking_software - lending_platform - insurance_software - bnpl_service - check_cashing_service - cloud_mining_schemes - consumer_lending - credit_repair_service - crypto_exchange_brokerage - crypto_trading_tools_software - debt_collection_agency - debt_relief_settlement - escrow_service - foreign_exchange_service - non_custodial_wallet_tools - payment_facilitation - prediction_market_exchange - stablecoin_issuance - token_sales_ico - tokenized_rwa - yield_staking_products - sports_betting_picks - fantasy_sports - horse_racing - poker_coaching - esports_betting - sports_analytics - nfl_betting - nba_betting - mlb_betting - soccer_betting - mma_ufc_betting - sports_picks_group - dfs_group - horse_racing_group - esports_picks_group - nfl_picks_group - nba_picks_group - soccer_picks_group - mlb_picks_group - mma_picks_group - prop_bets_group - fantasy_sports_free_to_play - licensed_gambling_operations - unlicensed_gambling - bodybuilding_coaching - strength_training - weight_loss_coaching - athletic_performance - yoga_instruction - martial_arts_instruction - running_coaching - calisthenics - flexibility_mobility - nutrition_coaching - swimming_coaching - cycling_coaching - boxing_coaching - mma_coaching - jiu_jitsu_coaching - wrestling_coaching - gymnastics_coaching - pilates_instruction - sports_nutrition - body_recomposition - golf_coaching - tennis_coaching - basketball_training - soccer_training - racket_sports_coaching - fitness_accountability - nutrition_community - weight_loss_group - bodybuilding_community - running_community - martial_arts_community - mental_health_group - biohacking_community - addiction_support_group - yoga_community - crossfit_community - longevity_community - womens_fitness_community - postpartum_fitness_group - chronic_illness_support - skincare_community - mental_health_coaching - life_coaching - biohacking - holistic_health - addiction_recovery_coaching - breathwork - meditation_mindfulness - gut_health_coaching - longevity_coaching - womens_health_coaching - mens_health_coaching - fertility_wellness - stress_management - grief_coaching - trauma_recovery_coaching - adhd_coaching - biomarker_health_coaching - telehealth_platform - ehr_software - practice_management - mental_health_app - fitness_app - nutrition_tracking_app - wellness_app - patient_engagement - medical_billing_software - pharmacy_management - lab_management - clinical_trial_software - dental_software - veterinary_software - health_data_platform - fitness_newsletter - mental_health_newsletter - longevity_newsletter - medical_newsletter - biohacking_newsletter - womens_health_newsletter - mens_health_newsletter - pharma_biotech_newsletter - ecommerce_education - amazon_fba_coaching - dropshipping_coaching - print_on_demand_coaching - retail_arbitrage - wholesale_coaching - startup_coaching - business_strategy - agency_building - smma_coaching - consulting_business - saas_entrepreneurship - local_business_coaching - cleaning_business_coaching - trucking_business_coaching - vending_machine_business - atm_business_coaching - car_wash_business - airbnb_business_coaching - private_label_coaching - etsy_coaching - merch_business_coaching - licensing_business - business_acquisition - women_entrepreneurship - affiliate_marketing_education - coaching_business_coaching - ecommerce_community - agency_community - saas_community - saas_marketing_community - real_estate_community - sales_community - affiliate_community - reselling_community - amazon_seller_community - dropshipping_community - freelancer_community - startup_founder_community - ceo_executive_community - women_business_community - marketing_community - ai_business_community - content_business_community - local_business_community - private_equity_community - wholesaling_community - coaching_business_community - make_money_online_community - startup_newsletter - ecommerce_newsletter - marketing_newsletter - sales_newsletter - small_business_newsletter - leadership_newsletter - agency_newsletter - saas_newsletter - hr_people_newsletter - legal_business_newsletter - real_estate_business_newsletter - solopreneur_newsletter - high_ticket_sales - b2b_sales_coaching - door_to_door_sales - sales_funnel_coaching - appointment_setting_coaching - insurance_sales_coaching - car_sales_coaching - retail_sales_coaching - solar_sales_coaching - lead_generation_agency - cold_email_agency - cold_calling_agency - sales_outsourcing - crm_implementation - appointment_setting_agency - sales_training_agency - revenue_operations_agency - inbound_teleservices - outbound_telemarketing - facebook_ads - google_ads - tiktok_marketing - youtube_marketing - instagram_growth - seo_coaching - email_marketing_coaching - copywriting_coaching - affiliate_marketing - local_seo - ai_marketing - webinar_marketing - event_marketing - saas_marketing_coaching - digital_marketing - smma - performance_marketing_agency - seo_agency - content_marketing_agency - email_marketing_agency - influencer_marketing_agency - pr_agency - branding_agency - video_marketing_agency - amazon_marketing_agency - podcast_marketing_agency - tiktok_agency - linkedin_agency - local_marketing_agency - dental_marketing_agency - real_estate_marketing_agency - restaurant_marketing_agency - ecommerce_marketing_agency - b2b_marketing_agency - growth_marketing_agency - affiliate_management_agency - conversion_optimization_agency - event_marketing_agency - click_farm_service - data_scraping_service - lead_list_sales - social_media_bot_farm - crm_software - email_marketing_software - sms_marketing_software - seo_tool - landing_page_builder - ad_management_tool - affiliate_tracking - review_management - analytics_dashboard - lead_gen_software - link_in_bio_tool - influencer_platform - webinar_platform - ab_testing_tool - chatbot_marketing - video_sales_tool - proposal_software - competitive_intelligence - social_listening_tool - whatsapp_marketing_tool - standalone_tipping - video_editing_education - photography_coaching - music_production - ui_ux_design_education - clipping_education - ugc_creation - 3d_modeling_education - dj_education - youtube_automation - blog_monetization - wedding_photography_education - calligraphy_lettering - illustration_education - fashion_design_education - interior_design_education - influencer_education - ai_content_creator_education - ai_nsfw_content_generation_education - web_design_agency - graphic_design_agency - ui_ux_agency - motion_design_agency - product_design_agency - logo_design_agency - presentation_design_agency - 3d_visualization_agency - fashion_design_agency - video_clipping_agency - video_production_agency - ugc_agency - content_writing_agency - translation_agency - social_media_management - ghostwriting_agency - podcast_editing_agency - thumbnail_design_agency - scriptwriting_agency - seo_content_agency - technical_writing_agency - photography_service - videography_service - music_production_service - voice_over_service - event_photography - drone_services - commercial_photography - portrait_photography_service - real_estate_photography - food_photography_service - live_event_production - podcast_production_service - freelance_design_gig - freelance_writing_gig - freelance_dev_gig - music_performance_gig - event_staffing_gig - model_talent_gig - photography_gig - videography_gig - voiceover_gig - illustration_gig - social_media_gig - dj_gig - face_painting_gig - clipping_gig - content_creator_community - video_editing_community - music_producer_community - photography_community - writing_community - design_community - youtube_creator_community - tiktok_creator_community - podcast_community - filmmaker_community - clipping_community - youtube_automation_community - pirated_digital_content - web_development_education - ai_ml_education - data_science_education - cybersecurity_education - cloud_computing_education - blockchain_education - no_code_education - automation_education - game_development_education - prompt_engineering - python_programming - javascript_programming - react_development - database_engineering - aws_certification - data_engineering - robotics_education - vr_ar_development - linux_sysadmin - wordpress_development - ai_agent_building - web_development_agency - mobile_app_agency - saas_development_agency - ecommerce_development - blockchain_development_agency - game_development_agency - devops_agency - ai_development_agency - wordpress_agency - shopify_agency - api_integration_agency - cybersecurity_agency - data_engineering_agency - vr_ar_development_agency - hacking_tools_malware - stalkerware_monitoring - developer_community - ai_community - cybersecurity_community - no_code_community - indie_hacker_community - devops_community - data_science_community - product_community - open_source_community - api_management - hosting_platform - database_tool - devops_tool - monitoring_tool - testing_tool - code_editor - no_code_builder - cdn_platform - error_tracking - documentation_tool - webhook_tool - 3d_weapon_files - background_check_services - document_falsification - fake_id_services - fake_reference_services - real_estate_wholesaling - house_flipping - property_development - rental_property - airbnb_str - commercial_real_estate - land_investing - section_8_housing - mobile_home_investing - multifamily_investing - self_storage_investing - property_management_education - vacation_rental_management - real_estate_crm - property_management_software - deal_analysis_tool - mls_search_tool - virtual_tour_software - real_estate_marketing_software - construction_management - home_valuation_tool - credit_repair_education - budgeting_coaching - tax_strategy_education - wealth_building - student_loan_strategy - credit_card_optimization - career_coaching - executive_coaching - management_coaching - tech_career_coaching - medical_career_coaching - trade_skills_education - va_training - bookkeeping_education - data_career_coaching - cybersecurity_career - consulting_career - investment_banking_career - law_career_coaching - nursing_career_coaching - teaching_career_coaching - personal_branding_career - mens_dating_coaching - womens_dating_coaching - relationship_coaching - marriage_coaching - communication_coaching - masculinity_coaching - femininity_coaching - breakup_recovery - manifestation_coaching - astrology_coaching - energy_healing - spiritual_coaching - faith_based_coaching - psychic_development - numerology_coaching - chakra_healing - shamanic_healing - biblical_coaching - islamic_coaching - productivity_coaching - public_speaking_coaching - mindset_coaching - stoicism_philosophy - mens_self_improvement - womens_self_improvement - leadership_development - anger_management - neurolinguistic_programming - appearance_and_grooming_coaching - amazon_kdp - self_publishing - audiobook_publishing - course_creation - digital_product_creation - ghostwriting_business - template_creation - ai_book_publishing - language_learning - tutoring - college_admissions_coaching - cpa_exam_prep - bar_exam_prep - real_estate_exam_prep - medical_board_prep - pmp_certification_prep - aws_certification_prep - comptia_certification - ap_exam_prep - graduate_school_prep - scholarship_coaching - homeschool_education - stem_education - financial_certification - coding_bootcamp_prep - cooking_culinary - travel_coaching - parenting_coaching - pet_training - gardening_education - diy_crafts - survival_prepping - baking_pastry - wine_sommelier - beer_brewing - mixology_bartending - woodworking - pottery_ceramics - knitting_crocheting - jewelry_making - aquarium_fishkeeping - bird_watching - astronomy_education - magic_illusion - car_restoration - motorcycle_riding - sailing_boating - scuba_diving - rock_climbing - skiing_snowboarding - surfing_education - homesteading - tiny_house_living - van_life - fashion_styling - floral_design - travel_planning_service - collectibles_coaching - car_enthusiast_community - sneakerhead_community - watch_collector_community - wine_enthusiast_community - cigar_community - cooking_community - gardening_community - fishing_community - hunting_community - diy_maker_community - golf_community - collectibles_community - sweepstakes_raffles - event_ticket_community - esports_coaching - game_specific_coaching - gaming_community - game_account_selling - unauthorized_ingame_currency - legal_education - music_theory - music_business - acting_coaching - dance_instruction - voice_acting - english_coaching - spanish_coaching - mandarin_coaching - french_coaching - german_coaching - japanese_coaching - korean_coaching - arabic_coaching - sign_language_education - accent_reduction - business_english - ai_chatbot_agency - ai_automation_agency - ai_consulting - workflow_automation_agency - data_analytics_agency - ai_voice_agent_agency - ai_content_agency - machine_learning_agency - computer_vision_agency - tech_recruiting_agency - executive_recruiting - staffing_agency - remote_staffing - healthcare_recruiting - va_placement_agency - sales_recruiting - creative_recruiting - finance_recruiting - legal_recruiting - construction_staffing - hospitality_staffing - customer_support_outsourcing - live_chat_agency - technical_support_agency - call_center_agency - multilingual_support_agency - community_management_agency - management_consulting - financial_consulting - hr_consulting - operations_consulting - it_consulting - sustainability_consulting - legal_consulting - compliance_consulting - supply_chain_consulting - change_management_consulting - digital_transformation_consulting - healthcare_consulting - real_estate_consulting - franchise_consulting - export_trade_consulting - nonprofit_consulting - education_consulting - cannabis_consulting - restaurant_consulting - m_and_a_consulting - pricing_strategy_consulting - brand_strategy_consulting - saas_marketing_consulting - done_for_you_services - prop_firm_passing_service - trading_account_management - done_for_you_trading - accounting_bookkeeping - tax_preparation - legal_services - notary_services - insurance_brokerage - financial_planning_service - real_estate_services - property_management - mortgage_brokerage - immigration_services - patent_trademark_services - business_formation_services - shell_company_formation - payroll_services - audit_services - forensic_accounting - actuarial_services - appraisal_services - mediation_arbitration - bail_bond_services - crowdfunding_platform - essay_mill_paper_mill - government_service_facilitation - immigration_services_unlicensed - licensed_legal_services - personalized_tax_services - private_investigation - repossession_services - unlicensed_legal_services - record_label - book_publishing_house - news_media_outlet - radio_broadcasting - tv_production_company - film_studio - magazine_publisher - music_licensing_agency - talent_management_agency - advertising_network - ad_tech_platform - cleaning_service - landscaping_service - plumbing_service - electrical_service - hvac_service - roofing_service - painting_service - moving_service - handyman_service - pest_control - pool_service - solar_installation - home_renovation - pressure_washing - junk_removal - garage_door_service - fencing_service - concrete_masonry - tree_service - window_cleaning - gutter_service - flooring_service - cabinet_countertop - home_inspection - septic_service - waterproofing_service - insulation_service - chimney_service - locksmith_service - glass_window_service - epoxy_coating - private_security_guard_service - armored_car_transport - executive_protection_bodyguard - event_security_service - alarm_system_installation - cctv_installation - private_investigation_agency - background_check_provider - locksmith_commercial - bounty_hunter_bail_enforcement - personal_styling - personal_chef - personal_assistant_service - tutoring_service - pet_services - wedding_planning - concierge_service - personal_training_service - nanny_service - elder_care_service - errand_service - life_organization - relocation_service - adult_dating_services - escort_services - hotel_accommodation_bookings - mail_order_spouse - psychic_fortune_telling - timeshare_sales - freight_brokerage - courier_service - warehousing_service - last_mile_delivery - auto_transport - international_shipping - cold_chain_logistics - commercial_airline_tickets - cruise_line_bookings - contract_manufacturing - cnc_machining_service - 3d_printing_service_commercial - plastic_injection_molding - metal_fabrication - pcba_assembly - chemical_manufacturing - textile_manufacturing - food_processing_facility - packaging_manufacturing - industrial_automation_integrator - mining_and_extraction - oil_and_gas_services - renewable_energy_generation - waste_management_recycling - hazardous_waste_disposal - aerospace_defense_contracting - personal_training_studio - nutrition_consulting - mental_health_counseling - physical_therapy_service - occupational_therapy_service - speech_therapy_service - chiropractic_service - acupuncture_service - massage_therapy_service - midwifery_doula - lactation_consulting - dietitian_service - addiction_recovery_services - dtc_lab_testing - iv_therapy_infusion - medspa_aesthetic_services - prescription_delivery_services - registered_dietitian_services - unlicensed_therapy_counseling - streetwear - athleisure - luxury_fashion - kids_clothing - custom_apparel - workwear - swimwear - lingerie_intimates - vintage_clothing - plus_size_fashion - maternity_clothing - sleepwear_loungewear - denim_brand - outerwear_jackets - socks_hosiery - costumes_cosplay - scrubs_medical_apparel - dance_performance_wear - hunting_camo_apparel - casual_everyday_clothing - protein_supplements - vitamins_minerals - pre_workout - nootropics - herbal_supplements - weight_management_supplements - gut_health - cbd_products - mushroom_supplements - collagen_supplements - testosterone_boosters - sleep_supplements - immune_support - joint_bone_health - greens_powder - creatine_supplements - electrolyte_hydration - prenatal_supplements - kids_supplements - pet_supplements - ayurvedic_supplements - keto_supplements - cannabis_thc_products - cbd_hemp_products_compliant - delta8_thc_products - dietary_supplements - drug_precursor_chemicals - illegal_drugs - kratom_kava_products - medical_treatment_claims_product - nutraceutical_products - otc_medication_sales - performance_enhancing_drugs - research_chemicals_dangerous - research_peptides - sexual_enhancement_products - tobacco_products - unlicensed_rx_sales - skincare - haircare - cosmetics_makeup - mens_grooming - fragrance - oral_care - sunscreen_spf - hair_growth_products - body_care - deodorant - lip_care - acne_treatment - men_skincare - baby_skincare - tattoo_aftercare - intimate_care - home_gym_equipment - yoga_equipment - combat_sports_gear - outdoor_fitness_gear - wearable_fitness - recovery_equipment - weightlifting_equipment - cardio_equipment - gymnastics_equipment - swimming_gear - jump_rope_equipment - grip_strength_tools - sauna_cold_plunge - posture_correctors - jewelry - sunglasses_eyewear - bags_wallets - hats_headwear - phone_accessories - travel_accessories - scarves_wraps - belts - hair_accessories - tech_accessories - keychains_charms - custom_engraved_accessories - cannabis_accessories_non_drug - drug_paraphernalia - high_value_goods_over_500 - precious_metals_stones - replica_counterfeit_goods - home_decor - candles_scents - kitchenware - bedding_linens - smart_home - cleaning_products - outdoor_furniture - organization_storage - wall_art_prints - rugs_carpets - lighting_fixtures - planters_garden_decor - bathroom_accessories - luxury_home_goods - seasonal_holiday_decor - pet_home_products - home_fragrance_diffusers - hazardous_chemicals_b2c - pre_orders_delayed_delivery - audio_equipment - camera_equipment - gaming_hardware - drones_robotics - ev_accessories - charging_power - smart_wearables - home_security_devices - 3d_printers - projectors_displays - streaming_devices - vr_headsets - e_readers - portable_tech - hardware_wallets - regulated_medical_devices - signal_jamming_devices - spy_cameras_hidden_recording - specialty_coffee_tea - health_food - snacks_treats - sauces_condiments - alcohol_spirits - meal_kits - baked_goods - beverages - pet_food_treats - protein_bars_snacks - jerky_meat_snacks - chocolate_confections - honey_sweeteners - olive_oil_vinegar - hot_sauce - dried_fruit_nuts - baby_food - plant_based_food - gluten_free_food - keto_food_products - subscription_food_box - kombucha_fermented - alcohol_sales - baby_products - kids_toys - kids_educational - baby_clothing_accessories - nursery_decor - kids_outdoor_play - kids_books - baby_safety_products - kids_arts_crafts - camping_hiking - fishing_gear - hunting_gear - cycling_gear - water_sports_gear - golf_equipment - snow_sports_gear - climbing_gear - archery_equipment - skateboarding_gear - pickleball_equipment - tennis_equipment - equestrian_gear - tactical_gear - overlanding_gear - explosives_fireworks - firearms_sales - self_defense_products - weapon_components - craft_kits - sewing_textiles - stationery - scrapbooking_supplies - beading_jewelry_supplies - pottery_supplies - printmaking_supplies - car_accessories - detailing_products - motorcycle_gear - truck_accessories - off_road_parts - car_audio_electronics - performance_parts - car_care_products - ev_charging_accessories - auto_repair_service - auto_body_shop - car_dealership - car_wash - tire_shop - oil_change_shop - auto_parts_store - motorcycle_shop - ev_charging_station - transmission_shop - muffler_exhaust_shop - auto_glass_shop - auto_upholstery_shop - car_audio_shop - smog_emissions_shop - truck_repair_shop - rv_repair_shop - boat_repair_shop - used_car_lot - auto_auction - dog_products - cat_products - aquarium_supplies - bird_supplies - reptile_supplies - horse_supplies - pet_apparel - pet_tech - pet_grooming_products - hand_tools - power_tools_and_accessories - hardware_and_fasteners - workshop_equipment_and_storage - safety_and_work_gear - painting_and_building_supplies - office_supplies - desk_accessories - printing_supplies - shipping_packaging - reusable_products - solar_powered_products - christian_books_bibles - christian_apparel - christian_jewelry - christian_home_decor - jewish_judaica - jewish_books_torah - jewish_apparel - islamic_books_quran - islamic_apparel - islamic_prayer_goods - hindu_puja_supplies - hindu_books_texts - buddhist_meditation_goods - buddhist_books_texts - sikh_religious_goods - other_religious_products - handmade_goods_marketplace - vintage_resale_marketplace - electronics_marketplace - auto_parts_marketplace - luxury_goods_marketplace - collectibles_marketplace - wholesale_marketplace - local_goods_marketplace - sneaker_marketplace - book_marketplace - furniture_marketplace - musical_instrument_marketplace - art_marketplace - ticket_marketplace - industrial_equipment_marketplace - craft_supply_marketplace - baby_kids_marketplace - outdoor_gear_marketplace - pet_marketplace - sustainable_goods_marketplace - cultural_artifacts_looted - dropshipping_operations - endangered_animal_products - human_body_parts_tissue - nft_marketplace - penny_auction - primary_event_ticketing - freelancer_marketplace - home_services_marketplace - tutoring_marketplace - legal_services_marketplace - healthcare_marketplace - wedding_services_marketplace - creative_and_content_creation_marketplace - beauty_services_marketplace - fitness_trainer_marketplace - pet_services_marketplace - childcare_marketplace - elder_care_marketplace - translation_marketplace - coaching_marketplace - therapy_marketplace - photography_marketplace - dj_entertainment_marketplace - auto_services_marketplace - freelance_marketplace_operator - equipment_rental_marketplace - vehicle_rental_marketplace - space_rental_marketplace - vacation_rental_marketplace - clothing_rental_marketplace - camera_gear_rental - rv_camper_rental - boat_rental_marketplace - storage_rental_marketplace - office_coworking_rental - parking_rental_marketplace - restaurant_marketplace - grocery_marketplace - catering_marketplace - homemade_food_marketplace - meal_prep_marketplace - bakery_marketplace - farm_produce_marketplace - chef_booking_marketplace - course_marketplace - template_marketplace - stock_media_marketplace - music_beats_marketplace - ebook_marketplace - plugin_theme_marketplace - 3d_model_marketplace - prompt_marketplace - code_snippet_marketplace - affiliate_marketing_platform - game_cheats_hacks - weapon_blueprint_distribution - saas_marketplace - agency_marketplace - manufacturing_marketplace - logistics_marketplace - commercial_real_estate_marketplace - business_for_sale_marketplace - food_delivery - grocery_delivery - package_delivery - moving_labor - alcohol_delivery - pharmacy_delivery - flower_delivery_gig - furniture_delivery_gig - catering_delivery - rideshare - chauffeur_service - bike_scooter_rental - boat_charter_gig - moving_truck_rental_gig - assembly_installation - waiting_line_service - personal_shopping - grocery_shopping_gig - gift_wrapping_gig - notary_gig - laundry_gig - car_wash_gig - cleaning_gig - lawn_care_gig - handyman_gig - pet_care_gig - childcare_gig - elder_care_gig - painting_gig - snow_removal_gig - pool_cleaning_gig - organizing_gig - pressure_washing_gig - junk_removal_gig - consulting_gig - accounting_gig - legal_gig - healthcare_gig - teaching_gig - translation_gig - data_entry_gig - research_gig - virtual_assistant_gig - sales_gig - recruiting_gig - mystery_shopping - focus_group_gig - product_testing_gig - drone_pilot_gig - fitness_instruction_gig - tour_guide_gig - dating_community - personal_development_community - spirituality_community - parenting_community - travel_community - networking_community - faith_community - mens_community - womens_community - expat_community - adult_community_nsfw - hate_violence_communities - personal_fundraising - political_fundraising - political_organizations - pornographic_content - registered_501c3 - religious_organization - unregistered_charities - ai_outreach_tool - ai_chatbot_software - ai_writing_tool - ai_image_generator - ai_video_tool - ai_voice_tool - ai_data_analysis - ai_code_assistant - ai_meeting_assistant - workflow_automation_software - ai_sales_tool - ai_customer_support - ai_recruiting_tool - ai_translation_tool - ai_music_tool - ai_presentation_tool - ai_research_tool - ai_seo_tool - ai_social_media_tool - ai_phone_agent - ai_legal_tool - ai_healthcare_tool - llm_api_platform - ai_agent_platform - generative_ai_platform - celebrity_impersonation - deepfake_service - ai_nsfw_content_generator - ecommerce_platform - product_research_tool - price_tracker - shipping_software - print_on_demand_software - marketplace_seller_tool - resale_arbitrage_tool - reseller_management_tool - product_review_software - returns_management - product_feed_management - checkout_optimization - wholesale_ordering - project_management_software - team_communication - video_conferencing - document_collaboration - time_tracking_software - scheduling_software - hr_software - knowledge_base_software - form_survey_builder - note_taking_app - task_management - contract_management - expense_management - okr_goal_tracking - employee_engagement - onboarding_software - applicant_tracking - asset_management - facility_management - visitor_management - community_platform - event_management_software - webinar_software - school_management - newsletter_platform - podcast_hosting - forum_software - virtual_classroom - restaurant_pos - salon_software - gym_management_software - auto_shop_software - legal_practice_software - church_management - nonprofit_software - logistics_software - agriculture_software - field_service_software - marina_management - hotel_pms - childcare_management - cleaning_business_software - roofing_software - landscaping_software - pest_control_software - tattoo_studio_software - cannabis_software - password_manager - cybersecurity_software - identity_verification - backup_recovery - endpoint_protection - email_security - access_management - compliance_software - data_privacy_tool - vpn_services - people_search_tool - game_mod_tool - streaming_tool - game_server_hosting - music_software - video_editing_software - photo_editing_software - animation_software - audio_editing_software - screen_recording_software - sports_betting_tool - fantasy_sports_paid_entry - iptv_pirated_streaming - loot_boxes_gacha - skill_contests_free_entry - skill_contests_paid_entry - only_fans_management_software - pornography_platform - business_phone_system - customer_messaging - digital_key_reselling - streaming_account_reselling - subscription_account_sharing - account_generation_tool - primary_care_telehealth - urgent_care_telehealth - pediatric_telehealth - geriatric_telehealth - family_medicine_telehealth - internal_medicine_telehealth - preventive_care_telehealth - licensed_online_pharmacy - telemedicine_practitioner_services - dermatology_telehealth - acne_telehealth - psoriasis_eczema_telehealth - skin_cancer_screening_tele - cosmetic_dermatology_tele - therapy_telehealth - psychiatry_telehealth - addiction_telehealth - couples_therapy_telehealth - child_psychology_telehealth - eating_disorder_telehealth - ptsd_trauma_telehealth - adhd_telehealth - anxiety_depression_telehealth - ocd_telehealth - grief_counseling_telehealth - anger_management_telehealth - family_therapy_telehealth - group_therapy_telehealth - licensed_psychedelic_therapy - womens_health_telehealth - mens_health_telehealth - sexual_health_telehealth - fertility_telehealth - hormone_therapy_telehealth - menopause_telehealth - prenatal_telehealth - postpartum_telehealth - erectile_dysfunction_tele - hair_loss_telehealth - birth_control_telehealth - sti_testing_telehealth - dental_telehealth - orthodontics_telehealth - optometry_telehealth - oral_surgery_consultation - vision_therapy_telehealth - cardiology_telehealth - endocrinology_telehealth - neurology_telehealth - orthopedic_telehealth - allergy_telehealth - ent_telehealth - rheumatology_telehealth - gastroenterology_telehealth - infectious_disease_telehealth - pulmonology_telehealth - nephrology_telehealth - oncology_telehealth - hematology_telehealth - urology_telehealth - weight_management_telehealth - glp1_weight_loss_tele - diabetes_management_tele - metabolic_health_tele - bariatric_telehealth - physical_therapy_telehealth - occupational_therapy_tele - speech_therapy_telehealth - pain_management_telehealth - cardiac_rehab_telehealth - pelvic_floor_telehealth - vestibular_telehealth - sleep_medicine_telehealth - chronic_disease_management - chronic_pain_telehealth - migraine_telehealth - asthma_copd_telehealth - nutrition_telehealth - naturopathic_telehealth - functional_medicine_telehealth - acupuncture_telehealth - health_coaching_telehealth - integrative_medicine_tele - ayurvedic_telehealth - genetic_counseling_telehealth - pharmacogenomics_tele - rare_disease_telehealth - second_opinion_telehealth - vet_telehealth - pet_behavior_telehealth - exotic_pet_telehealth - equine_telehealth - veterinary_services - class_action_settlement - mastermind_event - webinar_event - virtual_summit - bootcamp_event - workshop_seminar - hackathon - corporate_training_event - training_certification_event - convention_expo - conference_summit - industry_awards_event - product_launch_event - investor_demo_day - panel_discussion_event - pitch_competition - meetup_event - dinner_event - alumni_event - community_gathering - singles_event - professional_happy_hour - women_networking_event - founders_dinner - industry_mixer - concert_event - comedy_show - theater_performance - film_screening - music_festival - cultural_festival - fashion_show - drag_show - magic_show - dance_performance - poetry_spoken_word - art_exhibition - party_event - trivia_night - wine_tasting_event - beer_festival - car_show - food_festival - fitness_challenge_event - marathon_race - tournament_event - fight_event - yoga_retreat_event - outdoor_adventure_event - esports_tournament - obstacle_course_race - cycling_event - swim_meet - golf_tournament - pickleball_tournament - crossfit_competition - martial_arts_tournament - surfing_competition - wellness_retreat - spiritual_retreat - couples_retreat - plant_medicine_retreat - luxury_experience_event - detox_retreat - silent_retreat - creative_retreat - leadership_retreat - mens_retreat - womens_retreat - digital_detox_retreat - fundraiser_event - awareness_event - volunteer_event - charity_auction - benefit_concert - charity_run_walk - environmental_cleanup - family_festival - kids_event - holiday_event - farmers_market_event - block_party - graduation_ceremony - memorial_event - stock_market_newsletter - crypto_newsletter - personal_finance_newsletter - real_estate_newsletter - fintech_newsletter - venture_capital_newsletter - options_trading_newsletter - forex_newsletter - macro_economics_newsletter - alternative_investing_newsletter - tax_strategy_newsletter - ai_newsletter - tech_industry_newsletter - cybersecurity_newsletter - developer_newsletter - product_newsletter - devops_newsletter - open_source_newsletter - robotics_newsletter - climate_tech_newsletter - travel_newsletter - fashion_newsletter - parenting_newsletter - sports_newsletter - gaming_newsletter - music_entertainment_newsletter - book_reading_newsletter - dating_relationships_newsletter - home_design_newsletter - pet_newsletter - wine_spirits_newsletter - automotive_newsletter - political_newsletter - geopolitics_newsletter - media_journalism_newsletter - defense_security_newsletter - legal_policy_newsletter - design_newsletter - education_newsletter - science_newsletter - philosophy_newsletter - sustainability_newsletter - architecture_newsletter - history_newsletter - psychology_newsletter - career_newsletter - spirituality_newsletter - self_improvement_newsletter - productivity_newsletter - faith_newsletter - gym_facility - crossfit_box - yoga_studio - pilates_studio - martial_arts_gym - boxing_gym - climbing_gym - dance_studio - swimming_pool - sports_facility - golf_course - bowling_alley - skating_rink - trampoline_park - tennis_club - pickleball_facility - gymnastics_center - spin_studio - barre_studio - personal_training_studio_bm - recovery_studio - indoor_soccer - batting_cage - shooting_range - archery_range - equestrian_center - fine_dining - fast_casual_restaurant - steakhouse - seafood_restaurant - pizza_shop - sushi_restaurant - deli_sandwich_shop - bbq_restaurant - mexican_restaurant - italian_restaurant - chinese_restaurant - indian_restaurant - thai_restaurant - korean_restaurant - mediterranean_restaurant - vegan_vegetarian_restaurant - brunch_restaurant - ramen_noodle_shop - poke_bowl_shop - ethnic_restaurant - coffee_shop_cafe - bakery - juice_smoothie_bar - ice_cream_shop - donut_shop - bubble_tea_shop - food_truck - fast_food - ghost_kitchen - food_hall_vendor - catering_kitchen - butcher_shop - cheese_shop - farmers_market_stall - bar_lounge - brewery_taproom - winery_tasting - wine_bar - cocktail_bar - sports_bar - hookah_lounge - distillery - commercial_farming - livestock_ranching - hydroponic_vertical_farming - forestry_logging - aquaculture_fisheries - vineyard_winery_production - cannabis_cultivation - hemp_farming - grain_production - agricultural_cooperative - fertilizer_pesticide_sales - farm_equipment_sales - boutique_store - clothing_store - shoe_store - jewelry_store - electronics_store - bookstore - pet_store - toy_store - sporting_goods_store - thrift_store - smoke_shop - cannabis_dispensary - convenience_store - grocery_store - liquor_store - florist - gift_shop - furniture_store - home_improvement_store - art_gallery_retail - music_instrument_store - outdoor_recreation_store - phone_repair_store - watch_store - bridal_shop - maternity_store - kids_store - sneaker_store - vintage_store - comic_book_store - record_store - craft_supply_store - fabric_store - health_food_store - vitamin_supplement_store - optical_store - mattress_store - appliance_store - kitchen_bath_store - tile_flooring_store - paint_store - garden_center - gun_store - pawn_shop - dollar_store - hair_salon - nail_salon - day_spa - med_spa - massage_studio - tattoo_parlor - tanning_salon - beauty_supply_store - lash_brow_studio - waxing_studio - sauna_bathhouse - cryotherapy_studio - float_sensory_studio - iv_therapy_lounge - teeth_whitening_studio - microblading_studio - spray_tan_studio - blowout_bar - mens_barbershop - kids_salon - medical_office - dental_office - chiropractic_office - physical_therapy_clinic - optometry_office - dermatology_clinic - urgent_care_clinic - pharmacy - veterinary_clinic - mental_health_clinic - fertility_clinic - acupuncture_clinic - hearing_aid_center - orthopedic_clinic - pediatric_clinic - cosmetic_surgery_center - allergy_clinic - pain_management_clinic - dialysis_center - imaging_center - lab_testing_center - sleep_clinic - weight_loss_clinic - hormone_therapy_clinic - addiction_treatment_center - rehabilitation_center - occupational_therapy_clinic - speech_therapy_clinic - wound_care_center - funeral_home_mortuary - crematory_service - cemetery_memorial_park - casket_urn_retailer - pet_cremation_service - biohazard_cleanup - estate_liquidation - hotel - motel - boutique_hotel - bed_and_breakfast - hostel - resort - campground_rv - vacation_rental_property - extended_stay - glamping_site - cabin_rental - eco_lodge - retreat_center - tutoring_center - daycare_center - preschool - learning_center - music_school - art_school - driving_school - language_school - trade_school - coding_bootcamp_location - montessori_school - after_school_program - swim_school - cooking_school - test_prep_center - special_needs_center - adult_education_center - flight_school - cosmetology_school - movie_theater - escape_room - arcade - mini_golf - laser_tag - go_kart - amusement_park - museum - zoo_aquarium - theater_venue - nightclub - karaoke_bar - comedy_club - live_music_venue - axe_throwing - virtual_reality_arcade - board_game_cafe - cat_cafe - haunted_house - water_park - indoor_playground - concert_venue - drive_in_theater - billiards_hall - dart_bar - indoor_skydiving - law_office - real_estate_office - insurance_office - accounting_office - bank_credit_union - printing_shop - shipping_center - dry_cleaner - laundromat - storage_facility - coworking_space - check_cashing - title_company - travel_agency_storefront - staffing_office - financial_advisor_office - immigration_office - bail_bonds_office - pet_grooming - dog_daycare - pet_boarding - dog_training_facility - pet_spa - aquatic_pet_store - pet_bakery - pet_photography_studio - plumbing_showroom - hvac_showroom - solar_showroom - kitchen_design_showroom - bath_design_showroom - window_door_showroom - pool_spa_showroom - fireplace_showroom - countertop_showroom - nonprofit_organization - charity_foundation - political_campaign - community_organization - environmental_nonprofit - education_nonprofit - health_nonprofit - animal_welfare_nonprofit - arts_culture_nonprofit - social_justice_nonprofit - veterans_nonprofit - youth_nonprofit - disaster_relief_nonprofit - food_bank - housing_nonprofit - government_agency - public_utility - public_library - public_school - municipal_service - military_installation - embassy_consulate - niche_service - niche_product - hybrid_business - other_general - holding_company - family_office - cooperative - social_enterprise - incubator_accelerator - coworking_community - media_company - research_lab - null example: other type: - string - 'null' x-whop-hide-enum-values: true invoice_prefix: description: Prefix used for account invoices. example: SHINE type: - string - 'null' logo_url: description: Account logo image URL. example: >- https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: - string - 'null' metadata: description: Arbitrary key/value metadata supplied at account creation. example: external_id: shop_4417 region: austin type: object onboarding_type: description: Type of onboarding the account has completed. enum: - platform - seller - null example: seller type: - string - 'null' opengraph_image_url: description: Account Open Graph image URL. example: >- https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: - string - 'null' opengraph_image_variant: description: Account Open Graph image variant. enum: - white - black - orange - null example: black type: - string - 'null' other_business_description: description: Business type details when business_type is `other`. example: Mobile auto detailing type: - string - 'null' other_industry_description: description: Industry details when industry_type is `other`. example: Automotive services type: - string - 'null' owner: $ref: '#/components/schemas/UserSummary' description: >- The single user who owns the account, whose email is the `email` above. Distinct from the `owner` role on team members, which any number of them can hold. parent_account: description: >- Parent account for connected accounts, or `null` for standalone accounts. oneOf: - $ref: '#/components/schemas/AccountParent' - type: 'null' payment_controls: description: >- Payment health controls currently applied to the account. Computed only on `retrieve` and `me` for callers with `company:balance:read` scope; `null` otherwise. oneOf: - $ref: '#/components/schemas/AccountPaymentControls' - type: 'null' product_tax_code: description: >- Tax classification code applied by default to the account's products, with `id`, `name`, and `product_type`. `null` when no default is set. example: id: ptc_xxxxxxxxxxxxxx name: General - Digital Goods product_type: digital type: - object - 'null' recommended_actions: deprecated: true description: >- DEPRECATED: Use the `GET /recommended_actions?account_id={account_id}` endpoint instead. items: $ref: '#/components/schemas/AccountRecommendedAction' description: >- Deprecated: use the `GET /recommended_actions?account_id={account_id}` endpoint instead. Optional actions that unlock capabilities or grow the account, same shape as `required_actions`. Computed only on `retrieve` and `me`; `null` otherwise. type: - array - 'null' require_2fa: description: Whether authorized users must enable two-factor authentication. example: true type: boolean required_actions: items: $ref: '#/components/schemas/AccountRequiredAction' description: >- Actions the account owner must take to unblock capabilities like payouts and card spend, ordered by display priority. Computed only on `retrieve` and `me` for callers with `company:balance:read` scope; `null` otherwise. type: - array - 'null' route: description: Account public route identifier. example: biz_xxxxxxxxxxxxxx type: string send_customer_emails: description: >- Whether Whop sends transactional emails to customers on behalf of this account. example: false type: boolean show_joined_whops: description: Whether the account appears in joined whops on other accounts. example: false type: boolean show_reviews_dtc: description: Whether reviews are displayed on direct-to-consumer product pages. example: false type: boolean show_user_directory: description: Whether the account shows users in the user directory. example: false type: boolean social_links: items: $ref: '#/components/schemas/AccountSocialLink' description: Account social links. type: array stablecoin_rails: description: >- 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. example: false type: boolean status: description: >- Whether the account can operate on Whop: `active` or `suspended`. Computed on `list`, `retrieve`, and `me`; `null` otherwise. example: active type: - string - 'null' status_reason: description: >- 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. example: >- Payments are paused while we review recent chargebacks on this account. type: - string - 'null' store_page_config: $ref: '#/components/schemas/AccountStorePageConfig' description: Account store page display configuration. target_audience: description: Target audience for this account. example: Owners of new and enthusiast vehicles in Austin, TX type: - string - 'null' tax_collection_enabled_states: items: description: >- 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`). example: TX type: string type: array tax_identifiers: items: $ref: '#/components/schemas/AccountTaxIdentifier' description: Account tax/VAT registrations. Empty when none are set. type: array tax_remitted_by: description: >- 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. enum: - whop - self - none - null example: self type: - string - 'null' tax_type: description: >- 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. enum: - inclusive - exclusive - null example: inclusive type: - string - 'null' three_ds_level: description: >- Account-level 3D Secure behavior. `mandate_challenge` requires cardholder verification on supported card payments; `null` uses the standard checkout flow. enum: - mandate_challenge - null example: mandate_challenge type: - string - 'null' title: description: Account display name. example: Shine Time Auto Detailing type: string total_earned_usd: description: >- Account lifetime sales, normalized to USD. Computed only on `retrieve` and `me` for callers with `stats:read` scope; `null` otherwise. example: 0 type: - number - 'null' total_usd: description: >- 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. example: '50.00' type: - string - 'null' use_logo_as_opengraph_image_fallback: description: Whether the account uses its logo as the fallback Open Graph image. example: true type: boolean verification: description: >- 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`. example: business: null individual: null type: object volume_usd: description: >- 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. type: - number - 'null' wallet: description: >- Account primary crypto wallet, or `null` if none has been provisioned. oneOf: - $ref: '#/components/schemas/AccountWallet' - type: 'null' required: - id - email - title - description - route - logo_url - banner_image_url - business_type - country - home_preferences - industry_group - industry_type - invoice_prefix - onboarding_type - opengraph_image_url - opengraph_image_variant - other_business_description - other_industry_description - require_2fa - three_ds_level - collect_vat_id - target_audience - send_customer_emails - show_joined_whops - show_reviews_dtc - show_user_directory - store_page_config - metadata - created_at - use_logo_as_opengraph_image_fallback - total_earned_usd - status - status_reason - volume_usd - capabilities - payment_controls - cards - required_actions - recommended_actions - tax_remitted_by - tax_type - product_tax_code - business_address - business_name - tax_identifiers - tax_collection_enabled_states - total_usd - balances - stablecoin_rails - can_transfer_pending_balance_to_children - verification - company_formation - owner - parent_account - wallet - social_links type: object AccountBalanceToken: properties: balance: description: Total amount held in native units, as a decimal string. example: '50.0' type: string breakdown: $ref: '#/components/schemas/AccountBalanceBreakdown' description: >- Balance split into available, pending, and reserve amounts, as native-unit decimal strings, with the days the pending amount is expected to settle. On-chain crypto is entirely available; good_funds and fiat cash can have pending or reserve portions. icon_url: description: Holding icon URL. example: https://assets.whop.com/tokens/usd.png type: - string - 'null' name: description: The holding's display name example: US Dollar type: string price_usd: description: USD price per unit, or `null` when no exchange rate is available. example: 1 type: - number - 'null' symbol: description: Holding display symbol, such as `USDT`, `cbBTC`, or `EUR`. example: USD type: string value_usd: description: Holding USD value, or `null` when no exchange rate is available. example: '50.00' type: - string - 'null' required: - symbol - name - balance - value_usd - price_usd - icon_url - breakdown type: object AccountCapabilities: properties: accept_bank_payments: description: 'Bank payins: debits, transfers, and local bank rails' enum: - active - inactive - pending example: active type: string accept_bnpl_payments: description: Buy-now-pay-later payins; requires approval enum: - active - inactive - pending example: inactive type: string accept_card_payments: description: Card payins, including Apple Pay and Google Pay enum: - active - inactive - pending example: active type: string bank_deposit: description: Deposits by bank wire or ACH to the account's virtual bank account enum: - active - inactive - pending example: inactive type: string card_deposit: description: Balance top-ups by charging a stored payment method enum: - active - inactive - pending example: active type: string card_issuing: description: Issuing Whop cards; requires card application approval enum: - active - inactive - pending example: inactive type: string crypto_deposit: description: On-chain deposits to the account's crypto wallet enum: - active - inactive - pending example: active type: string crypto_payout: description: On-chain payouts to a crypto wallet enum: - active - inactive - pending example: inactive type: string instant_payout: description: Instant payouts to an eligible payout destination enum: - active - inactive - pending example: inactive type: string run_ads: description: >- Launching ad campaigns through Whop Ads. `inactive` while a requested ads services agreement is awaiting the account's signature. enum: - active - inactive - pending example: active type: string standard_payout: description: Standard payouts to an external payout destination enum: - active - inactive - pending example: inactive type: string transfer: description: Transfers to other accounts enum: - active - inactive - pending example: inactive type: string required: - accept_card_payments - accept_bank_payments - accept_bnpl_payments - standard_payout - instant_payout - crypto_payout - transfer - bank_deposit - crypto_deposit - card_deposit - card_issuing - run_ads type: object AccountCards: properties: kind: description: >- Whether the card application verifies a business (`business`, KYB) or a person (`individual`, consumer identity). `null` when the application is not yet linked to a verification. enum: - individual - business - null example: individual type: - string - 'null' status: description: >- Where the card application stands. `approved` means cards can be issued. `needs_verification` means the applicant has not completed identity verification yet; `needs_information` means they did, but the documents were rejected for a fixable reason and must be resubmitted. `pending` and `manual_review` are in flight. `denied`, `locked`, and `canceled` are terminal. enum: - approved - pending - manual_review - denied - locked - canceled - needs_verification - needs_information example: approved type: string required: - kind - status type: object AccountCompanyFormation: additionalProperties: true properties: documents: items: $ref: '#/components/schemas/AccountCompanyFormationDocument' description: >- Formation documents available for download, such as the Articles of Organization and the EIN confirmation letter. Present once `status` leaves `draft`. type: array ein_registered: description: >- Whether the company's EIN has been issued by the IRS. Present once `status` leaves `draft`. example: false type: boolean legal_name: description: >- Registered company name including the entity ending, for example `Acme, LLC`. Present once `status` leaves `draft`. example: Shine Time Auto Detailing, LLC type: - string - 'null' signatures: $ref: '#/components/schemas/AccountCompanyFormationSignatures' description: >- IRS forms still awaiting a founder's signature, each with a hosted signing URL. Present once `status` leaves `draft`; empty when nothing needs signing. state_registered: description: >- Whether the state formation filing is complete. Present once `status` leaves `draft`. example: true type: boolean status: enum: - draft - processing - filed - rejected - completed type: string required: [] type: object UserSummary: properties: id: description: User ID, prefixed `user_`. example: user_xxxxxxxxxxxxxx type: string name: description: Display name. example: Dana Whitfield type: - string - 'null' profile_picture: $ref: '#/components/schemas/UserProfilePicture' description: >- Avatar wrapper; its `url` is always present, using a generated placeholder when the user set no picture. username: description: Public username. example: danawhitfield type: string required: - id - username - name - profile_picture type: object AccountParent: properties: id: description: Account ID, prefixed `biz_`. example: biz_xxxxxxxxxxxxxx type: string logo_url: description: Account logo image URL. example: >- https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: - string - 'null' route: description: Account public route identifier. example: shine-time-holdings type: string title: description: Account display name. example: Shine Time Holdings type: string required: - id - title - route - logo_url type: object AccountPaymentControls: properties: dispute_alert_auto_refund: $ref: '#/components/schemas/AccountDisputeAlertAutoRefundControl' description: Automatic refund settings for pre-chargeback dispute alerts. dispute_alert_fee_usd: description: Fee charged for each dispute alert in USD. `null` when unavailable. example: 29 type: - number - 'null' enforce_3ds: description: >- Whether 3-D Secure is forced on every card payment at checkout. The account cannot bypass it while set. example: false type: boolean financing_disabled: description: >- Whether payment health controls explicitly disable financing. This is independent of financing approval in `capabilities.accept_bnpl_payments`. example: false type: boolean high_risk_processing_fee_percentage: description: Additional processing fee percentage for high-risk processing. example: 0 type: number pending_auto_topup_fee_percentage: description: >- Percentage fee charged when pending, not-yet-settled balance is advanced to fund the account's cards balance, where `2` means 2%. `0` when the account is exempt. example: 2 type: number pending_balance_delay_days: description: Additional days payments remain pending before becoming available. example: 0 type: integer reserve: $ref: '#/components/schemas/AccountReserveControl' description: Reserve currently applied to incoming payment volume. resolution_center_auto_refund: $ref: '#/components/schemas/AccountResolutionCenterAutoRefundControl' description: Automatic refund settings for resolution center cases. restricted_payment_methods: items: description: >- Card brands blocked at checkout for this account. Empty when none are blocked. The account cannot re-enable them itself. enum: - card_visa - card_mastercard - card_american_express - card_discover_global_network example: card_visa type: string type: array required: - dispute_alert_auto_refund - resolution_center_auto_refund - dispute_alert_fee_usd - high_risk_processing_fee_percentage - pending_auto_topup_fee_percentage - pending_balance_delay_days - financing_disabled - reserve - enforce_3ds - restricted_payment_methods type: object AccountRecommendedAction: properties: action: description: >- The recommendation; new values may be added, so handle unknown actions gracefully enum: - theme_business - create_product - create_plan - verify_identity - connect_affiliate_program - create_promotion - migrate_from_stripe - accept_first_payment - launch_first_ad - launch_draft_campaign - increase_ad_budget - refresh_ad_creatives - fix_ad_billing - exclude_customers_from_ads - retarget_abandoned_checkouts - fix_funnel_dropoff - invite_team_member - enable_tax_collection - create_card - apply_for_financing example: apply_for_financing type: string blocked_capabilities: items: description: Capabilities this would unlock, or empty example: accept_bnpl_payments type: string type: array cta: description: The URL the call-to-action links to example: https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/settings/payments/ type: string cta_label: description: Button label example: Apply type: string description: description: Supporting copy, or empty example: Let customers pay over time with buy now, pay later. type: string icon_url: description: Illustration icon URL, or `null` example: https://whop.com/illustrations/orange/piggy-bank.svg type: - string - 'null' impact_score: description: Estimated impact from 0-100, or `null` when not ranked example: 86 type: - integer - 'null' reasoning: description: Why this action was recommended, or `null` example: >- Financing lifts conversion on the $249 ceramic coating, the priciest job on the menu. type: - string - 'null' status: description: Always optional — never blocking enum: - optional example: optional type: string title: description: Headline for the recommendation example: Offer financing at checkout type: string required: - action - status - title - description - cta_label - cta - icon_url - blocked_capabilities - reasoning - impact_score type: object AccountRequiredAction: properties: action: description: >- What the holder must do; new values may be added, so handle unknown actions gracefully enum: - deposit_funds - submit_information_request - reauthorize_payout_methods - update_payout_profile - card_usage_review - verify_identity - sign_formation_documents - connect_fulfillment_tracker - setup_apple_pay_domains - configure_tax_remitter - add_vat_registration example: verify_identity type: string blocked_capabilities: items: description: Capabilities gated until this is resolved example: standard_payout type: string type: array cta: description: The URL the call-to-action links to, or null when there is no button example: https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/balance/ type: - string - 'null' cta_label: description: Button label, or empty when there is no button example: Verify now type: string description: description: Supporting copy, or empty example: Complete verification to withdraw your earnings. type: string icon_url: description: The URL of the action's illustration icon, or null if it has none example: https://whop.com/illustrations/orange/shield.svg type: - string - 'null' status: description: required (act now) or pending (under review) enum: - required - pending example: required type: string title: description: Headline for the action example: Complete your identity verification type: string required: - action - status - title - description - cta_label - cta - icon_url - blocked_capabilities type: object AccountSocialLink: properties: id: description: The ID of the social link example: social_1 type: string title: description: The optional display title for the social link example: '@shinetimedetail' type: - string - 'null' url: description: The social link URL example: https://instagram.com/shinetimedetail type: string website: description: The social platform for this link enum: - x - instagram - facebook - tiktok - youtube - linkedin - twitch - website - custom example: instagram type: string required: - id - website - url - title type: object AccountStorePageConfig: properties: accent_color: description: Accent color used on the account store page. enum: - ruby - tomato - red - crimson - pink - plum - purple - violet - iris - cyan - teal - jade - green - grass - brown - blue - orange - indigo - sky - mint - yellow - amber - lime - lemon - magenta - gold - bronze - gray - null example: red type: - string - 'null' layout: description: Layout used on the account store page. enum: - featured - compact - null example: compact type: - string - 'null' profile_variant: description: Profile presentation used on the account store page. enum: - personal - business - null example: business type: - string - 'null' whop_affiliate_link: description: Whether the account store page shows a Whop affiliate link. example: true type: boolean required: - accent_color - layout - profile_variant - whop_affiliate_link type: object AccountTaxIdentifier: properties: id: description: Tax identifier ID. example: txid_xxxxxxxxxxxxxx type: string tax_id_type: description: Tax ID type. enum: - ad_nrt - ao_tin - ar_cuit - al_tin - am_tin - aw_tin - au_abn - au_arn - eu_vat - az_tin - bs_tin - bh_vat - bd_bin - bb_tin - by_tin - bj_ifu - bo_tin - ba_tin - br_cnpj - br_cpf - bg_uic - bf_ifu - kh_tin - cm_niu - ca_bn - ca_gst_hst - ca_pst_bc - ca_pst_mb - ca_pst_sk - ca_qst - cv_nif - cl_tin - cn_tin - co_nit - cd_nif - cr_tin - hr_oib - do_rcn - ec_ruc - eg_tin - sv_nit - et_tin - eu_oss_vat - ge_vat - gh_tin - de_stn - gb_vat - gn_nif - hk_br - hu_tin - is_vat - in_gst - id_npwp - il_vat - jp_cn - jp_rn - jp_trn - kz_bin - ke_pin - kg_tin - la_tin - li_uid - li_vat - my_frp - my_itn - my_sst - mr_nif - mx_rfc - md_vat - me_pib - ma_vat - np_pan - nz_gst - ng_tin - mk_vat - no_vat - no_voec - om_vat - pe_ruc - ph_tin - pl_nip - ro_tin - ru_inn - ru_kpp - sa_vat - sn_ninea - rs_pib - sg_gst - sg_uen - si_tin - za_vat - kr_brn - es_cif - ch_uid - ch_vat - tw_vat - tj_tin - tz_vat - th_vat - tr_tin - ug_tin - ua_vat - ae_trn - us_ein - uy_ruc - uz_tin - uz_vat - ve_rif - vn_tin - zm_tin - zw_tin - sr_fin - xi_vat example: eu_vat type: string tax_id_value: description: Tax ID value. example: DE123456789 type: string required: - id - tax_id_type - tax_id_value type: object AccountWallet: properties: address: description: The on-chain address of the wallet example: '0xabc123' type: string id: description: Wallet ID, prefixed `wallet_`. example: cwal_xxxxxxxxxxxxxx type: string network: description: The blockchain network the wallet lives on enum: - solana - ethereum - bitcoin example: ethereum type: string required: - id - address - network type: object V1ErrorResponse: properties: error: properties: code: description: >- Machine-readable reason for this specific refusal, such as `bank_warning_not_acknowledged`. Only present when the error carries one. type: string message: description: Human-readable error message. example: account_id is required type: string type: description: Machine-readable error code. example: bad_request type: string required: - type - message type: object required: - error type: object AccountBalanceBreakdown: properties: available: description: >- Amount you can spend, send, or withdraw now, in native units, as a decimal string. example: '1500.0' type: string in_transit: description: >- Amount moving between the account's own destinations, such as a treasury sweep to its crypto wallet or a card top-up. In native units, as a decimal string. example: '0' type: string pending: description: >- Amount from recent payments still settling, in native units, as a decimal string. example: '0' type: string pending_settlements: items: $ref: '#/components/schemas/AccountBalanceSettlement' description: >- When the pending amount is expected to settle, one entry per day, earliest first. Money with no scheduled settlement day, such as a transfer in flight, is left out — so these can sum to less than `pending`, never more. type: array reserve: description: >- Amount held back, in native units, as a decimal string. Retrieve the account's reserves for why it is held and when it unlocks. example: '0' type: string required: - available - pending - in_transit - reserve - pending_settlements type: object AccountCompanyFormationDocument: properties: id: description: Document ID, prefixed `file_`. example: file_xxxxxxxxxxxxxx type: string name: description: Human-readable document name, such as `Articles of Organization`. example: Articles of Organization type: string type: description: >- Document category: `articles_of_organization`, `operating_agreement`, `ein_letter`, `signed_ss4`, `signed_form8821`, or `mail` for postal correspondence received on the company's behalf. example: articles_of_organization type: string url: description: CDN URL for downloading the document. example: >- https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: string required: - id - name - type - url type: object AccountCompanyFormationSignatures: additionalProperties: true properties: form8821: $ref: '#/components/schemas/AccountCompanyFormationSignatureRequest' description: >- Signature state for IRS Form 8821, the tax information authorization. Present only while the form still needs the founder's action. ss4: $ref: '#/components/schemas/AccountCompanyFormationSignatureRequest' description: >- Signature state for IRS Form SS-4, the EIN application. Present only while the form still needs the founder's action. required: [] type: object UserProfilePicture: properties: url: description: >- Avatar image URL. Always present — a generated placeholder when the user set no picture. example: https://ui-avatars.com/api/ type: string required: - url type: object AccountDisputeAlertAutoRefundControl: properties: locked: description: Whether the account owner is prevented from changing this threshold. example: false type: boolean threshold_usd: description: >- Maximum dispute alert amount automatically refunded in USD. `null` when automatic refunds are disabled. example: 500 type: - number - 'null' required: - threshold_usd - locked type: object AccountReserveControl: properties: hold_period_days: description: Number of days reserved funds are held before release. example: 14 type: integer percentage: description: >- Percentage of incoming payment volume held in reserve. `null` when no reserve is applied. example: 15 type: - number - 'null' required: - percentage - hold_period_days type: object AccountResolutionCenterAutoRefundControl: properties: card_threshold_usd: description: >- Maximum card-funded resolution center case amount automatically refunded in USD. `null` when automatic refunds are disabled for cards. example: 50 type: - number - 'null' financing_threshold_usd: description: >- Maximum financing-funded resolution center case amount automatically refunded in USD. `null` when automatic refunds are disabled for financing. example: 25 type: - number - 'null' locked: description: >- Whether the account owner is prevented from changing these thresholds. example: false type: boolean paypal_threshold_usd: description: >- Maximum PayPal-funded resolution center case amount automatically refunded in USD. `null` when automatic refunds are disabled for PayPal. example: 40 type: - number - 'null' required: - card_threshold_usd - financing_threshold_usd - paypal_threshold_usd - locked type: object AccountBalanceSettlement: properties: amount: description: Amount expected that day, in native units, as a decimal string. example: '12.5' type: string date: description: >- The day this money is expected to finish settling, as an ISO 8601 date. example: '2026-01-01' type: string required: - date - amount type: object AccountCompanyFormationSignatureRequest: properties: expires_at: description: >- When the signing URL expires, as an ISO 8601 timestamp. Present while `status` is `pending`. example: '2026-01-01T12:00:00.000Z' type: string status: description: >- `pending` when a signing session is ready for the founder; `unknown` when the signature state could not be determined. enum: - pending - unknown example: pending type: string url: description: >- Hosted signing URL where the founder completes the form. Present while `status` is `pending`. example: https://sign.doola.com/shine-time-auto-detailing/form8821 type: string required: - status type: object responses: InvalidParameters: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Invalid Parameters Unauthorized: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Unauthorized Forbidden: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Forbidden securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````