> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # List a partner business referral's earnings > Lists the earnings Whop pays out for one referred business's activity, most recent first. ## OpenAPI ````yaml /openapi/api-v1-native.json get /partners/businesses/{id}/earnings 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-08-1 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 account time series for 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 and retrieve existing bank deposit activity. 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 an identity review 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: Identity review 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 Referrals 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 Workforce 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 Workforce Bounties API to 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: Workforce Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - 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 and list 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: /partners/businesses/{id}/earnings: parameters: - $ref: '#/components/parameters/ApiVersionDate' - description: The business referral ID (a coma_ identifier). in: path name: id required: true schema: type: string get: tags: - Partners summary: List a partner business referral's earnings description: >- Lists the earnings Whop pays out for one referred business's activity, most recent first. operationId: listBusinessReferralEarnings parameters: - description: Filter by earning status. in: query name: status required: false schema: enum: - awaiting_settlement - pending - completed - canceled - reversed type: string - in: query name: first required: false schema: default: 20 maximum: 100 type: integer - in: query name: after required: false schema: type: string - in: query name: last required: false schema: maximum: 100 type: integer - in: query name: before required: false schema: type: string - description: The field to sort earnings by. in: query name: order required: false schema: default: created_at enum: - created_at - commission_amount - transaction_amount - payout_at type: string - description: Sort direction. in: query name: direction required: false schema: default: desc enum: - asc - desc type: string - description: Only return earnings created before this timestamp. in: query name: created_before required: false schema: type: string - description: Only return earnings created after this timestamp. in: query name: created_after required: false schema: type: string responses: '200': content: application/json: schema: properties: data: items: properties: account: description: Referred account. properties: id: description: Referred account ID. type: string logo_url: description: Referred account logo URL. type: - string - 'null' route: description: Referred account route. type: string title: description: Referred account display name. type: string required: - id - title - logo_url - route type: - object - 'null' cancelation_reason: description: >- Why the earning was canceled or reversed, if applicable. type: - string - 'null' commission_amount_usd: description: >- What the referrer earns, in USD. Null until the earning settles. type: - string - 'null' created_at: format: date-time type: string financial_activity: description: >- Income and cost lines behind this earning's commission. Null for earnings settled before this data was recorded. items: properties: amount: description: Line amount in its native currency. type: string amount_usd: description: Line amount in USD. type: string category: description: Fee or cost category of the line. type: - string - 'null' created_at: format: date-time type: - string - 'null' currency: description: Currency of the native amount. type: string type: description: >- Whether the line is income Whop collected or a cost Whop paid. enum: - income - expense example: income type: string required: - type - category - currency - amount - amount_usd - created_at type: object type: - array - 'null' id: type: - string - 'null' object: enum: - business_referral_earning type: string payout_at: format: date-time type: - string - 'null' payout_percentage: description: >- The referrer's share of Whop's gross profit, as a fraction (0.3 = 30%). Null until the earning settles. format: float type: - number - 'null' product: properties: id: type: string route: type: string title: type: string required: - id - title - route type: - object - 'null' resource: anyOf: - properties: alternative_payment_method: properties: image_url: type: - string - 'null' name: type: string required: - name - image_url type: - object - 'null' brand: type: - string - 'null' created_at: format: date-time type: string currency: type: string id: type: string last4: type: - string - 'null' object: enum: - receipt type: string payment_method_type: type: - string - 'null' processor: type: - string - 'null' required: - object - id - currency - payment_method_type - processor - brand - last4 - created_at - alternative_payment_method type: - object - 'null' - type: 'null' description: The resource that generated the affiliate earning. second_tier: description: >- Whether this earning is a second-tier (grandparent) commission. type: boolean status: description: Current status of the earning. enum: - awaiting_settlement - pending - completed - canceled - reversed example: pending type: string transaction_amount_usd: description: >- The sale amount the commission is calculated from, in USD. type: string required: - object - id - account - product - status - second_tier - transaction_amount_usd - payout_percentage - commission_amount_usd - financial_activity - cancelation_reason - created_at - payout_at - resource type: object type: array page_info: properties: end_cursor: type: - string - 'null' has_next_page: type: boolean has_previous_page: type: boolean start_cursor: type: - string - 'null' required: - has_next_page - end_cursor - has_previous_page - start_cursor type: object required: - data - page_info type: object description: earnings listed '400': $ref: '#/components/responses/InvalidParameters' description: invalid sort direction security: - bearerAuth: - partner:basic:read components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: 2026-07-08-1 type: string responses: InvalidParameters: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Invalid Parameters schemas: 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 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 ````