import type * as Whop from "../index.mjs"; export interface Account { /** Lifetime charged ad spend for the account, in USD. Computed only on `list` for callers with `stats:read` on the account; `null` otherwise. */ ads_spend_usd: number | null; balances: Whop.AccountBalanceToken[]; /** Account banner image URL. */ banner_image_url: string | null; /** Account business address used to calculate tax, with `line1`, `line2`, `city`, `state`, `postal_code`, and `country`. `null` when no address is set. */ business_address: Record | null; /** The account's legal business name used with its tax address. */ business_name: string | null; /** 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. */ business_type: string | null; /** Whether pending funds may be transferred from this platform account to its connected accounts. */ can_transfer_pending_balance_to_children: boolean; /** The account's cancellation policy document, or `null` if they have not published one. */ cancellation_policy: Whop.File_ | null; /** 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. */ capabilities: Whop.AccountCapabilities | null; /** Whop Cards application details for the account. Returned on `list`, `retrieve`, and `me` for callers with `company:balance:read` scope; `null` otherwise, or when the account has no card application or blocking application review. */ cards: Whop.AccountCards | null; /** Whether checkout shows a VAT/tax ID field for buyers to optionally enter. Does not require a VAT ID to purchase. */ collect_vat_id: boolean; /** 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. */ company_formation: Whop.AccountCompanyFormation; /** Country where the account is located. */ country: string | null; /** When the account was created, as an ISO 8601 timestamp. */ created_at: string; /** Distinct customers with a paid receipt at the account in the last 30 days, refreshed every few hours. Computed only on `retrieve` for callers with `stats:read` on the account; `null` otherwise, and when the count is unavailable. */ customers_l30d: number | null; /** Account promotional description. */ description: string | null; /** How many team members report to the business directly, with no manager above them. Present on single-account reads. */ direct_reports_count?: number | undefined; /** Whether Whop assembles and files dispute evidence for this account. Enabling it opts the account into the success fee charged on disputes it wins. */ dispute_fighter_enabled: boolean; /** Whether Economic Intelligence is on for the account. It turns off automatically when its committed period ends. */ economic_intelligence: boolean; /** Account owner email address. */ email: string | null; /** The account's end-user license agreement document, or `null` if they have not published one. */ eula: Whop.File_ | null; /** The account's most recent financing application. Computed only on `retrieve` and `me` for callers with `company:balance:read` scope; `null` otherwise, or when the account has never applied for financing. */ financing: Whop.AccountFinancing | null; home_preferences: Account.HomePreferences.Item[]; /** Account ID, prefixed `biz_`. */ id: string; /** 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. */ industry_type: string | null; /** Prefix used for account invoices. */ invoice_prefix: string | null; /** The Whop Levels progress of the account's `owner`, counted across every account they own, so all of them show the same level. Computed only on `retrieve` and `me` for callers with `company:basic:read` scope; `null` otherwise, and when the account is not in Whop Levels. */ level: Whop.AccountLevel | null; /** Account logo image URL. */ logo_url: string | null; /** Arbitrary key/value metadata supplied at account creation. */ metadata: Record; /** Type of onboarding the account has completed. */ onboarding_type: Account.OnboardingType | null; /** Account Open Graph image URL. */ opengraph_image_url: string | null; /** Account Open Graph image variant. */ opengraph_image_variant: Account.OpengraphImageVariant | null; /** Whether payment orchestration is enabled for this account. */ orchestration_enabled: boolean; /** Business type details when business_type is `other`. */ other_business_description: string | null; /** Industry details when industry_type is `other`. */ other_industry_description: string | null; /** 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. */ owner: Whop.UserSummary; /** Parent account for connected accounts, or `null` for standalone accounts. */ parent_account: Whop.AccountParent | null; /** The account's active first-tier partner. Present on retrieve responses; null when no active first-tier partner is attributed to the account. Omitted from other responses. */ partner?: (Whop.AccountPartner | null) | undefined; /** Payment health controls currently applied to the account. Computed only on `retrieve` and `me` for callers with `company:balance:read` scope; `null` otherwise. */ payment_controls: Whop.AccountPaymentControls | null; platform_credits: Whop.Money[]; /** The account's privacy policy document, or `null` if they have not published one. */ privacy_policy: Whop.File_ | null; /** Tax classification code applied by default to the account's products, with `id`, `name`, and `product_type`. `null` when no default is set. */ product_tax_code: Record | null; /** DEPRECATED: Use the `GET /economic_intelligence?account_id={account_id}` endpoint instead. */ recommended_actions: Whop.AccountRecommendedAction[] | null; /** Whether authorized users must enable two-factor authentication. */ require_2fa: boolean; required_actions: Whop.AccountRequiredAction[] | null; /** The account's return policy document, or `null` if they have not published one. */ return_policy: Whop.File_ | null; rewards?: Whop.AccountPartnerReward[] | undefined; /** Account public route identifier. */ route: string; /** Whether Whop sends transactional emails to customers on behalf of this account. */ send_customer_emails: boolean; /** The account's shipping policy document, or `null` if they have not published one. */ shipping_policy: Whop.File_ | null; /** Whether the account appears in joined whops on other accounts. */ show_joined_whops: boolean; /** Whether reviews are displayed on direct-to-consumer product pages. */ show_reviews_dtc: boolean; /** Whether the account shows users in the user directory. */ show_user_directory: boolean; social_links: Whop.AccountSocialLink[]; /** Whether the account can operate on Whop: `active` or `suspended`. Computed on `list`, `retrieve`, `me`, and `suspend`; `null` otherwise. */ status: string | null; /** Why the account was suspended, as the label shown to the account owner, such as `Suspended - Fraudulent activity`. Computed on `retrieve`, `me`, and `suspend`; `null` otherwise, when `status` is not `suspended`, and when the suspension was recorded without a reason. */ status_reason: string | null; /** Account store page display configuration. */ store_page_config: Whop.AccountStorePageConfig; /** Target audience for this account. */ target_audience: string | null; tax_collection_enabled_states: string[]; tax_identifiers: Whop.AccountTaxIdentifier[]; /** 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. */ tax_remitted_by: Account.TaxRemittedBy | null; /** 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. */ tax_type: Account.TaxType | null; /** The account's terms of service document, or `null` if they have not published one. */ terms_of_service: Whop.File_ | null; /** 3D Secure behavior for supported on-session card payments. `mandate_challenge` requires a 3DS challenge before payment processing; `mandate_if_required` mandates a challenge only when the payment processor requires it; `frictionless_if_required` uses the regular frictionless 3DS flow. Payments of $1,000 or more use `mandate_if_required` unless `mandate_challenge` is selected. Risk and authentication recovery requirements can override the preference. `null` uses the standard checkout flow. */ three_ds_level: Account.ThreeDsLevel | null; /** Account display name. */ title: string; /** Account lifetime sales, normalized to USD. Computed only on `retrieve` and `me` for callers with `stats:read` scope; `null` otherwise. */ total_earned_usd: number | null; /** 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. */ total_usd: string | null; /** The trading account address and its WebSocket subscriptions. Opt in with `include_trading=true` on single-account reads. `null` otherwise, without trading permission, or without an Ethereum wallet. */ trading: Whop.TradingAccount | null; /** Whether the account uses its logo as the fallback Open Graph image. */ use_logo_as_opengraph_image_fallback: boolean; /** 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`. */ verification: Record; /** Volume through the account in the last 30 days (GMV from paid receipts), normalized to USD. Computed only on `list` for callers with `stats:read` on the account; `null` otherwise. */ volume_l30d_usd: number | null; /** 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. */ volume_usd: number | null; /** Account primary crypto wallet, or `null` if none has been provisioned. */ wallet: Whop.AccountWallet | null; /** The account's business website URL, or `null` if none has been provided. Setting it also adds a `website` entry to `social_links`. */ website: string | null; /** When the account turned on Whop Partner mode, as an ISO 8601 timestamp. Present on single-account reads and update responses; `null` until the account turns Whop Partner mode on by sending `whop_partner_enabled: true` on update. */ whop_partner_enabled_at?: (string | null) | undefined; } export declare namespace Account { type HomePreferences = HomePreferences.Item[]; namespace HomePreferences { /** Public account home page preferences. */ const Item: { readonly HideMemberCount: "hide_member_count"; readonly HideMembersCard: "hide_members_card"; }; type Item = (typeof Item)[keyof typeof Item]; } /** Type of onboarding the account has completed. */ const OnboardingType: { readonly Platform: "platform"; readonly Seller: "seller"; }; type OnboardingType = (typeof OnboardingType)[keyof typeof OnboardingType]; /** Account Open Graph image variant. */ const OpengraphImageVariant: { readonly White: "white"; readonly Black: "black"; readonly Orange: "orange"; }; type OpengraphImageVariant = (typeof OpengraphImageVariant)[keyof typeof OpengraphImageVariant]; /** 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. */ const TaxRemittedBy: { readonly Whop: "whop"; readonly Self: "self"; readonly None: "none"; }; type TaxRemittedBy = (typeof TaxRemittedBy)[keyof typeof TaxRemittedBy]; /** 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. */ const TaxType: { readonly Inclusive: "inclusive"; readonly Exclusive: "exclusive"; }; type TaxType = (typeof TaxType)[keyof typeof TaxType]; /** 3D Secure behavior for supported on-session card payments. `mandate_challenge` requires a 3DS challenge before payment processing; `mandate_if_required` mandates a challenge only when the payment processor requires it; `frictionless_if_required` uses the regular frictionless 3DS flow. Payments of $1,000 or more use `mandate_if_required` unless `mandate_challenge` is selected. Risk and authentication recovery requirements can override the preference. `null` uses the standard checkout flow. */ const ThreeDsLevel: { readonly MandateChallenge: "mandate_challenge"; readonly MandateIfRequired: "mandate_if_required"; readonly FrictionlessIfRequired: "frictionless_if_required"; }; type ThreeDsLevel = (typeof ThreeDsLevel)[keyof typeof ThreeDsLevel]; }