> ## 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. # Retrieve User > Retrieves a user by `user_` tag or username, or the authenticated user with the reserved id `me`. Profiles include linked social accounts — reading your own profile returns every linked account, other profiles only what is public on Whop (the primary Discord and the X account). The self-only fields are populated only when the id is `me`: `email` (email-read scope), `staff` (Whop staff only, staff-read scope), `balance` and `earnings_usd` (balance-read scope), and the opt-in `balance_history`. They are always `null` when addressing a user by tag or username. ## OpenAPI ````yaml /openapi/api-v1-native.json get /users/{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-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: /users/{id}: parameters: - $ref: '#/components/parameters/ApiVersionDate' - description: >- User ID (prefixed `user_`), username, or `me` for the authenticated user. in: path name: id required: true schema: type: string get: tags: - Users summary: Retrieve User description: >- Retrieves a user by `user_` tag or username, or the authenticated user with the reserved id `me`. Profiles include linked social accounts — reading your own profile returns every linked account, other profiles only what is public on Whop (the primary Discord and the X account). The self-only fields are populated only when the id is `me`: `email` (email-read scope), `staff` (Whop staff only, staff-read scope), `balance` and `earnings_usd` (balance-read scope), and the opt-in `balance_history`. They are always `null` when addressing a user by tag or username. operationId: retrieveUser parameters: - description: >- When set, returns the user's account-specific profile overrides for this account. in: query name: account_id required: false schema: type: string - description: >- Also compute your balance history (opt-in; runs a heavier query). Only applies when the id is `me`; ignored for callers without balance-read scope. in: query name: include_balance_history required: false schema: type: boolean - description: >- Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago. Only used with `include_balance_history`. in: query name: from required: false schema: type: string - description: >- Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only used with `include_balance_history`. in: query name: to required: false schema: type: string - description: >- Balance-history point granularity. Defaults to `day`. Only used with `include_balance_history`. in: query name: interval required: false schema: enum: - hour - day - week - month type: string - description: >- IANA time zone the balance-history points are bucketed in. Defaults to `UTC`. Only used with `include_balance_history`. in: query name: time_zone required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: user retrieved '404': $ref: '#/components/responses/NotFound' description: no user with that id security: - {} - bearerAuth: [] x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop(); const user = await client.users.retrieve('id'); console.log(user.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: User: properties: balance: description: >- The user's balance: personal cash + crypto + in-flight treasury deposits, plus account balances for accounts they own. Computed only on the self view (retrieved with the reserved id `me`) for callers with balance-read scope; `null` otherwise. oneOf: - $ref: '#/components/schemas/UserBalance' - type: 'null' balance_history: description: >- The user's cumulative wallet balance over time (USD `{ t, v }` points plus last/min/max), for the balance chart. Opt in with `include_balance_history=true` when retrieving yourself with the reserved id `me`; populated only for callers with balance-read scope and `null` otherwise. A user with no wallet activity returns an empty series. oneOf: - $ref: '#/components/schemas/UserBalanceHistory' - type: 'null' banner: description: >- The user's profile banner wrapper. `null` when the user has no banner. oneOf: - $ref: '#/components/schemas/UserBanner' - type: 'null' bio: description: The user's biography example: Ceramic coating specialist. Detailing cars in Austin since 2016. type: - string - 'null' created_at: description: When the user was created, as an ISO 8601 timestamp example: '2026-01-01T12:00:00.000Z' type: string earnings_usd: description: >- The user's gross USD income over time. Populated only on single-user self reads for callers with balance-read scope; `null` otherwise. oneOf: - $ref: '#/components/schemas/UserEarnings' - type: 'null' email: description: >- The user's email address. Populated only on the self view (retrieved with the reserved id `me`) for callers with email-read scope; `null` otherwise, or while the account has no confirmed email yet. example: marcus@shinetime.example type: - string - 'null' id: description: User ID, prefixed `user_`. example: user_xxxxxxxxxxxxxx type: string name: description: The user's display name example: Marcus Webb 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. social_accounts: items: $ref: '#/components/schemas/SocialAccount' description: >- Social accounts linked to the user (Discord, X/Twitter, Telegram), oldest first. Reading your own profile returns every linked account; other profiles only include what is public on Whop (the primary Discord and the X account). Empty when none are linked. type: array staff: description: >- Whop staff access flags. Populated only on the self view (retrieved with the reserved id `me`) for callers with staff-read scope; `null` there for every user who is not Whop staff, and always `null` elsewhere. oneOf: - $ref: '#/components/schemas/UserStaffAccess' - type: 'null' username: description: The user's unique username example: marcuswebb type: string verification: description: >- Identity verification status for the user's `individual` (KYC) and `business` (KYB) profiles. Each is `null` until created, otherwise a `status` of `not_started`, `pending`, `approved`, or `rejected`. example: business: null individual: null type: object whop_partner_enabled_at: description: >- When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. `null` if never enrolled. example: '2026-01-01T12:00:00.000Z' type: - string - 'null' required: - id - username - name - bio - created_at - profile_picture - banner - social_accounts - email - staff - balance - earnings_usd - balance_history - verification - whop_partner_enabled_at type: object UserBalance: properties: businesses: items: $ref: '#/components/schemas/UserBalanceBusiness' description: >- Account balances for accounts the user owns, highest balance first. Excludes accounts with no balance. type: array businesses_total_usd: description: Combined USD balance across every account the user owns. example: '18940.25' type: string cash: items: $ref: '#/components/schemas/UserBalanceCash' description: Per-currency fiat cash balances. type: array cash_usd: description: Fiat cash in USD, including pending, in-transit, and reserve. example: '0.00' type: string crypto: items: $ref: '#/components/schemas/UserBalanceToken' description: Per-token crypto holdings in the ledger's own wallet. type: array crypto_usd: description: Crypto holdings in USD. example: '0.00' type: string pending_usd: description: >- Fiat pending and in-transit balances, plus in-flight treasury deposits, in USD. example: '0.00' type: string total_usd: description: >- The user's personal balance in USD: cash (available + pending + in-transit + reserve) + crypto + in-flight treasury deposits. Excludes account balances (see businesses_total_usd). example: '0.00' type: string treasury_pending_usd: description: Balance-to-wallet USDT0 withdrawals still in flight, in USD. example: '0.00' type: string required: - total_usd - cash_usd - crypto_usd - treasury_pending_usd - pending_usd - cash - crypto - businesses_total_usd - businesses type: object UserBalanceHistory: properties: data: items: $ref: '#/components/schemas/UserBalanceHistoryPoint' description: Cumulative balance points over the requested window, oldest first. type: array last: description: Value of the most recent point, in USD. example: 0 type: number max: description: Maximum value across the window, in USD. example: 0 type: number min: description: Minimum value across the window, in USD. example: 0 type: number required: - data - last - min - max type: object UserBanner: properties: url: description: Profile banner image URL. example: >- https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: string required: - url type: object UserEarnings: properties: first_earned_at: description: >- The first time the user earned gross income, as an ISO 8601 timestamp. example: '2026-01-01T12:00:00.000Z' type: - string - 'null' owned_accounts: $ref: '#/components/schemas/UserEarningsAmount' description: Gross income from accounts the user owns or is owner-authorized on. personal: $ref: '#/components/schemas/UserEarningsAmount' description: Gross income from the user's personal wallet. total: $ref: '#/components/schemas/UserEarningsAmount' description: >- Gross income from the user's personal wallet plus accounts they own or are owner-authorized on. required: - total - personal - owned_accounts - first_earned_at 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 SocialAccount: properties: error: description: >- Why this social account currently can't be used for advertising — a failed share or a Meta-side restriction. Null when the account is healthy. example: >- You don't have permission to share this account. Ask an admin of its Meta Business Portfolio to grant you full control, then share it again. type: - string - 'null' external_id: description: The platform-specific ID for this social account. example: '1234567891' type: - string - 'null' id: description: Unique identifier for the social account. example: sacc_xxxxxxxxxxxxxx type: string name: description: The display name of the social account on the platform. example: Shine Time Auto Detailing type: - string - 'null' parent_social_account: description: >- The social account this one belongs to on the platform, such as the Facebook page that owns an Instagram account. Null when the social account stands on its own. oneOf: - $ref: '#/components/schemas/SocialAccountParent' - type: 'null' platform: description: The platform the social account exists on. enum: - x - instagram - youtube - tiktok - facebook - discord - telegram example: instagram type: string profile_picture_url: description: >- The URL where the profile picture of the social account can be accessed. example: https://shinetime.example/logo.png type: - string - 'null' scopes: items: description: >- Capabilities Whop retains specific to this social account. For example, Whop may request the ability to run advertisements that use this social account's identity, reflected by the presence of `advertise` in this value. example: advertise type: string type: array url: description: >- The URL where the social account can be accessed on the platform. Null while a Whop-owned page is still being provisioned. example: https://instagram.com/shinetimedetail type: - string - 'null' username: description: >- The username of the social account on the platform. Null while a Whop-owned page is still being provisioned. example: shinetimedetail type: - string - 'null' verified: description: Whether the social account is verified on the platform. example: true type: boolean required: - id - platform - username - name - url - profile_picture_url - verified - external_id - scopes - error - parent_social_account type: object UserStaffAccess: properties: admin: description: >- Whether the user holds the admin staff role with a valid second factor. example: true type: boolean investigation_access: description: >- Whether the user can open Whop-internal investigation tooling right now: a qualifying staff role plus their investigation toggle switched on. example: true type: boolean manager: description: >- Whether the user holds the manager staff role with a valid second factor. example: false type: boolean support: description: >- Whether the user holds the support staff role with a valid second factor. example: false type: boolean required: - admin - support - manager - investigation_access 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 UserBalanceBusiness: properties: balance_usd: description: The account's total balance in USD. example: '18940.25' type: string id: description: The account ID, which looks like biz_*************. example: biz_xxxxxxxxxxxxxx type: string logo_url: description: The account's logo URL. example: https://assets.whop.com/logos/shine-time-auto-detailing.png type: - string - 'null' name: description: The account's display name. example: Shine Time Auto Detailing type: - string - 'null' required: - id - name - logo_url - balance_usd type: object UserBalanceCash: properties: balance: description: Available balance in the native currency. example: 4385.75 type: number balance_usd: description: Available balance converted to USD. example: 4385.75 type: number currency: description: Lowercase ISO currency code, such as `usd` or `eur`. example: usd type: string in_transit_balance_usd: description: Balance moving to the user's own wallet or card, converted to USD. example: 0 type: number pending_balance_usd: description: Pending balance converted to USD. example: 310 type: number price_usd: description: >- USD price per native currency unit, or `null` when no exchange rate is available. type: - number - 'null' reserve_balance_usd: description: Reserved balance converted to USD. example: 125 type: number total_withdrawable_balance: description: Withdrawable amount in the native currency. example: 4385.75 type: number required: - currency - balance - balance_usd - pending_balance_usd - in_transit_balance_usd - reserve_balance_usd - price_usd - total_withdrawable_balance type: object UserBalanceToken: properties: balance: description: Amount held in native token units, as a decimal string. example: '1500.0' type: string breakdown: $ref: '#/components/schemas/AccountBalanceBreakdown' description: >- Balance split into available, pending, in-transit, and reserve amounts, as native-unit decimal strings. Transfers between the user's own wallet and card are reported in `in_transit` until they arrive. icon_url: description: Token icon URL. example: https://assets.whop.com/tokens/usdt.png type: - string - 'null' name: description: The token's display name. example: Tether USD type: - string - 'null' price_usd: description: USD price per token, or `null` when unknown. example: 1 type: - number - 'null' symbol: description: Token display symbol, such as `USDT`, `XAUT`, or `cbBTC`. example: USDT type: string value_usd: description: Holding USD value. example: 1500 type: number required: - symbol - name - balance - value_usd - price_usd - icon_url - breakdown type: object UserBalanceHistoryPoint: properties: t: description: Point timestamp, in Unix seconds. example: 1767268800 type: integer v: description: Cumulative wallet balance at this point, in USD. example: 2400 type: number required: - t - v type: object UserEarningsAmount: properties: last_24_hours: description: Gross income in USD over the last 24 hours. example: '0.00' type: string last_30_days: description: Gross income in USD over the last 30 days. example: '260.00' type: string last_7_days: description: Gross income in USD over the last 7 days. example: '60.00' type: string lifetime: description: All-time gross income in USD. example: '4120.25' type: string required: - lifetime - last_30_days - last_7_days - last_24_hours type: object SocialAccountParent: properties: external_id: description: The platform-specific ID for the parent social account. example: '555111' type: - string - 'null' id: description: Social account ID, prefixed `sacc_`. example: sacc_xxxxxxxxxxxxxx type: string name: description: The display name of the parent social account on the platform. example: Shine Time Auto Detailing type: - string - 'null' platform: description: The platform the parent social account exists on. enum: - x - instagram - youtube - tiktok - facebook - discord - telegram example: facebook type: string profile_picture_url: description: >- The URL where the profile picture of the parent social account can be accessed. example: https://shinetime.example/logo.png type: - string - 'null' username: description: The username of the parent social account on the platform. example: shinetimedetailing type: - string - 'null' verified: description: Whether the parent social account is verified on the platform. example: true type: boolean required: - id - platform - username - name - profile_picture_url - verified - external_id 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 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 responses: NotFound: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Resource not found 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 ````