> ## 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. # Update Account > Updates an account. User tokens can update business accounts; business account API keys can update connected accounts. ## OpenAPI ````yaml /openapi/api-v1-native.json patch /accounts/{account_id} 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-07-18' 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: > 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 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 payouts from stablecoin accounts, list payout history for accounts or users, monitor payout statuses, 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: > 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 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: > 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.' - 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: > 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 represents a visitor or customer of an account, assembled from [pixel events](/api-reference/beta/events/event) and purchase activity — ad clicks, storefront visits, and checkouts. Use the People API to list the people of an account and retrieve a single person. name: People x-whop-summary: Visitors and customers of an account, aggregated from pixel events. - 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. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - 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. 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. 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 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.' paths: /accounts/{account_id}: patch: tags: - Accounts summary: Update Account description: >- Updates an account. User tokens can update business accounts; business account API keys can update connected accounts. operationId: updateAccount parameters: - description: Account ID, prefixed `biz_`. in: path name: account_id required: true schema: type: string requestBody: content: application/json: schema: properties: affiliate_application_required: description: >- Whether prospective affiliates must submit an application before promoting this account. type: boolean affiliate_instructions: description: Guidelines shown to affiliates promoting this account. type: - string - 'null' banner_image: additionalProperties: true description: Attachment input for the account banner image. type: - object - 'null' business_address: description: >- Account business address used to calculate tax. A complete address in a supported country is required when `tax_remitted_by` is `self`. properties: city: description: City name. type: - string - 'null' country: description: >- Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. type: string line1: description: First line of the street address. type: string line2: description: Second line of the street address. type: - string - 'null' postal_code: description: Postal or ZIP code. type: - string - 'null' state: description: State, province, or region code, for example `CA`. type: - string - 'null' type: object business_type: description: High-level business category for the account. type: - string - 'null' country: description: Country where the account is located. type: - string - 'null' description: description: Account promotional description. type: - string - 'null' featured_affiliate_product_id: description: >- The ID of the product to feature for affiliates. Pass `null` to clear. type: - string - 'null' home_preferences: description: Public account home page preferences. items: type: string type: array industry_group: description: Account industry group. type: - string - 'null' industry_type: description: Specific industry vertical for the account. type: - string - 'null' invoice_prefix: description: Prefix used for account invoices. type: - string - 'null' logo: additionalProperties: true description: Attachment input for the account logo. type: - object - 'null' metadata: additionalProperties: true description: Arbitrary key/value metadata to store on the account. type: object onboarding_type: description: The type of onboarding the account has completed. type: - string - 'null' opengraph_image: additionalProperties: true description: Attachment input for the account Open Graph image. type: - object - 'null' opengraph_image_variant: description: The account Open Graph image variant. type: - string - 'null' other_business_description: description: >- The description of the business type when business_type is other. type: - string - 'null' other_industry_description: description: >- The description of the industry type when industry_type is other. type: - string - 'null' product_tax_code_id: description: >- ID of the tax classification code applied by default to the account's products. See the available [product categories](https://docs.numeral.com/essentials/product-categories). type: - string - 'null' require_2fa: description: >- Whether the account requires authorized users to have two-factor authentication enabled. type: boolean route: description: The unique URL slug for the account. type: - string - 'null' send_customer_emails: description: >- Whether Whop sends transactional emails to customers on behalf of this account. type: boolean show_joined_whops: description: >- Whether the account appears in joined whops on other accounts. type: boolean show_reviews_dtc: description: >- Whether reviews are displayed on direct-to-consumer product pages. type: boolean show_user_directory: description: Whether the account shows users in the user directory. type: boolean social_links: description: The full list of social links to display for the account. items: additionalProperties: true type: object type: array store_page_config: additionalProperties: true description: Account store page display configuration. type: - object - 'null' target_audience: description: The target audience for this account. type: - string - 'null' tax_collection_enabled_states: description: >- US state codes (50 states plus `DC`) where the account collects tax. Replaces the full set on update. Only settable when `tax_remitted_by` is `self`. items: enum: - AL - AK - AZ - AR - CA - CO - CT - DE - DC - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY type: string type: array tax_identifiers: description: >- Account tax/VAT registrations to add or update. When `tax_remitted_by` is `self`, tax is calculated and collected only in the countries where the account holds a registration. items: properties: tax_id_type: description: >- Tax ID type, for example `eu_vat`, `gb_vat`, or `us_ein`. 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 - 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 type: string tax_id_value: description: Tax ID value, for example `DE123456789`. type: string required: - tax_id_type - tax_id_value type: object 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). `self` requires a `business_address` in a supported country. enum: - whop - self - none type: string title: description: The display name of the account. type: - string - 'null' use_logo_as_opengraph_image_fallback: description: >- Whether the account uses its logo as the fallback Open Graph image. type: boolean type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Account' description: account updated '400': $ref: '#/components/responses/InvalidParameters' description: store page config is not an object '401': $ref: '#/components/responses/Unauthorized' description: missing or invalid authentication '403': $ref: '#/components/responses/Forbidden' description: credential lacks the required update scope '404': $ref: '#/components/responses/NotFound' description: no account with that ID is visible to the credential security: - bearerAuth: - company:update 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 }); const account = await client.accounts.update('account_id'); console.log(account.id); components: 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. 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. type: - object - 'null' business_type: description: High-level business category for the account. type: - string - 'null' 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' country: description: Country where the account is located. type: - string - 'null' created_at: description: When the account was created, as an ISO 8601 timestamp. type: string description: description: Account promotional description. type: - string - 'null' email: description: Account owner email address. type: - string - 'null' home_preferences: items: description: Public account home page preferences. type: string type: array id: description: Account ID, prefixed `biz_`. type: string industry_group: description: Account industry group. type: - string - 'null' industry_type: description: Specific industry vertical for the account. type: - string - 'null' invoice_prefix: description: Prefix used for account invoices. type: - string - 'null' llc_formation: description: >- LLC formation state for the account: a draft state with `payment_pending`, or the live filing state with registration progress, documents, and pending signatures. type: object logo_url: description: Account logo image URL. type: - string - 'null' metadata: description: Arbitrary key/value metadata supplied at account creation. type: object onboarding_type: description: Type of onboarding the account has completed. type: - string - 'null' opengraph_image_url: description: Account Open Graph image URL. type: - string - 'null' opengraph_image_variant: description: Account Open Graph image variant. type: - string - 'null' other_business_description: description: Business type details when business_type is `other`. type: - string - 'null' other_industry_description: description: Industry details when industry_type is `other`. type: - string - 'null' parent_account_id: description: Parent account ID for connected accounts. type: - string - '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. type: - object - 'null' recommended_actions: deprecated: true description: >- DEPRECATED: Use the `GET /accounts/{account_id}/recommend_actions` endpoint instead. items: $ref: '#/components/schemas/AccountRecommendedAction' description: >- Deprecated: use the `GET /accounts/{account_id}/recommend_actions` 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. 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. type: string send_customer_emails: description: >- Whether Whop sends transactional emails to customers on behalf of this account. type: boolean show_joined_whops: description: Whether the account appears in joined whops on other accounts. type: boolean show_reviews_dtc: description: Whether reviews are displayed on direct-to-consumer product pages. type: boolean show_user_directory: description: Whether the account shows users in the user directory. type: boolean social_links: items: $ref: '#/components/schemas/AccountSocialLink' description: Account social links. type: array status: description: >- Whether the account can operate on Whop: `active` or `suspended`. Computed only on `retrieve` and `me`; `null` otherwise. type: - string - 'null' store_page_config: description: Account store page display configuration. type: object target_audience: description: Target audience for this account. 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`). type: string type: array tax_identifiers: description: >- Account tax/VAT registrations, each with `id`, `tax_id_type`, and `tax_id_value`. 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. type: - string - 'null' title: description: Account display name. 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. 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. type: - string - 'null' use_logo_as_opengraph_image_fallback: description: Whether the account uses its logo as the fallback Open Graph image. 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`, `approved`, or `rejected`. type: object 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 - target_audience - send_customer_emails - show_joined_whops - show_reviews_dtc - show_user_directory - store_page_config - parent_account_id - metadata - created_at - use_logo_as_opengraph_image_fallback - total_earned_usd - status - capabilities - payment_controls - required_actions - recommended_actions - tax_remitted_by - product_tax_code - business_address - tax_identifiers - tax_collection_enabled_states - total_usd - balances - verification - llc_formation - wallet - social_links type: object AccountBalanceToken: properties: balance: description: Total amount held in native units, as a decimal string. type: string breakdown: description: >- Balance split into available, pending, and reserve amounts, as native-unit decimal strings. On-chain crypto is entirely available; good_funds and fiat cash can have pending or reserve portions. type: object icon_url: description: Holding icon URL. type: - string - 'null' name: description: The holding's display name type: string price_usd: description: USD price per unit, or `null` when no exchange rate is available. type: - number - 'null' symbol: description: Holding display symbol, such as `USDT`, `cbBTC`, or `EUR`. type: string value_usd: description: Holding USD value, or `null` when no exchange rate is available. 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: active 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: active 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: active 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: active type: string instant_payout: description: Instant payouts to an eligible payout destination enum: - active - inactive - pending example: active type: string standard_payout: description: Standard payouts to an external payout destination enum: - active - inactive - pending example: active type: string transfer: description: Transfers to other accounts enum: - active - inactive - pending example: active 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 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. type: - number - 'null' financing_disabled: description: >- Whether payment health controls explicitly disable financing. This is independent of financing approval in `capabilities.accept_bnpl_payments`. type: boolean high_risk_processing_fee_percentage: description: >- Additional processing fee percentage for high-risk processing. Currently `0` for all accounts. type: number pending_balance_delay_days: description: Additional days payments remain pending before becoming available. 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. required: - dispute_alert_auto_refund - resolution_center_auto_refund - dispute_alert_fee_usd - high_risk_processing_fee_percentage - pending_balance_delay_days - financing_disabled - reserve 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 - setup_tracking_pixel - 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 - invite_team_member - enable_tax_collection - create_card - join_whop_university - apply_for_financing example: theme_business type: string blocked_capabilities: items: description: Capabilities this would unlock, or empty type: string type: array cta: description: The URL the call-to-action links to type: string cta_label: description: Button label type: string description: description: Supporting copy, or empty type: string icon_url: description: Illustration icon URL, or `null` type: - string - 'null' impact_score: description: Estimated impact from 0-100, or `null` when not ranked type: - integer - 'null' reasoning: description: Why this action was recommended, or `null` type: - string - 'null' status: description: Always optional — never blocking enum: - optional example: optional type: string title: description: Headline for the recommendation 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 - verify_identity - connect_fulfillment_tracker example: deposit_funds type: string blocked_capabilities: items: description: Capabilities gated until this is resolved type: string type: array cta: description: The URL the call-to-action links to, or null when there is no button type: - string - 'null' cta_label: description: Button label, or empty when there is no button type: string description: description: Supporting copy, or empty type: string icon_url: description: The URL of the action's illustration icon, or null if it has none 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 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 type: string title: description: The optional display title for the social link type: - string - 'null' url: description: The social link URL type: string website: description: The social platform for this link enum: - x - instagram - facebook - tiktok - youtube - linkedin - twitch - website - custom example: x type: string required: - id - website - url - title type: object AccountWallet: properties: address: description: The on-chain address of the wallet type: string id: description: Wallet ID, prefixed `wallet_`. type: string network: description: The blockchain network the wallet lives on enum: - solana - ethereum - bitcoin example: solana type: string required: - id - address - network type: object V1ErrorResponse: properties: error: properties: message: description: Human-readable error message. type: string type: description: Machine-readable error code. type: string required: - type - message type: object required: - error type: object AccountDisputeAlertAutoRefundControl: properties: locked: description: Whether the account owner is prevented from changing this threshold. type: boolean threshold_usd: description: >- Maximum dispute alert amount automatically refunded in USD. `null` when automatic refunds are disabled. type: - number - 'null' required: - threshold_usd - locked type: object AccountReserveControl: properties: hold_period_days: description: Number of days reserved funds are held before release. type: integer percentage: description: >- Percentage of incoming payment volume held in reserve. `null` when no reserve is applied. 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. 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. type: - number - 'null' locked: description: >- Whether the account owner is prevented from changing these thresholds. 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. type: - number - 'null' required: - card_threshold_usd - financing_threshold_usd - paypal_threshold_usd - locked 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 NotFound: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Resource not found securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer type: http ````