> ## 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 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.yml get /referrals/businesses/{id}/earnings openapi: 3.1.0 info: title: Whop API description: >- Hand-written V1 endpoints. Merged into the GraphqlRestProxy-generated schema at build time. version: v1 servers: - url: https://{defaultHost} variables: defaultHost: default: api.whop.com/api/v1 security: [] paths: /referrals/businesses/{id}/earnings: parameters: - $ref: '#/components/parameters/ApiVersionDate' - name: id in: path required: true schema: type: string description: The business referral ID (a coma_ identifier). get: tags: - Referrals summary: List a business referral's earnings description: >- Lists the earnings Whop pays out for one referred business's activity, most recent first. operationId: listBusinessReferralEarnings parameters: - name: status in: query required: false schema: type: string enum: - awaiting_settlement - pending - completed - canceled - reversed description: Filter by earning status. - name: first in: query required: false schema: type: integer default: 20 maximum: 100 - name: after in: query required: false schema: type: string - name: last in: query required: false schema: type: integer maximum: 100 - name: before in: query required: false schema: type: string - name: order in: query required: false schema: type: string enum: - created_at - commission_amount - transaction_amount - payout_at default: created_at description: The field to sort earnings by. - name: direction in: query schema: type: string enum: - asc - desc default: desc required: false description: Sort direction. - name: created_before in: query required: false schema: type: string description: Only return earnings created before this timestamp. - name: created_after in: query required: false schema: type: string description: Only return earnings created after this timestamp. responses: '200': description: earnings listed content: application/json: schema: type: object properties: data: type: array items: type: object properties: object: type: string enum: - business_referral_earning id: type: - string - 'null' account: type: - object - 'null' description: Referred account. properties: id: type: string description: Referred account ID. title: type: string description: Referred account display name. logo_url: type: - string - 'null' description: Referred account logo URL. route: type: string description: Referred account route. required: - id - title - logo_url - route product: type: - object - 'null' properties: id: type: string title: type: string route: type: string required: - id - title - route status: type: string enum: - awaiting_settlement - pending - completed - canceled - reversed example: pending description: Current status of the earning. transaction_amount_usd: type: string description: >- The sale amount the commission is calculated from, in USD. payout_percentage: type: - number - 'null' format: float description: >- The referrer's share of Whop's gross profit, as a fraction (0.3 = 30%). Null until the earning settles. commission_amount_usd: type: - string - 'null' description: >- What the referrer earns, in USD. Null until the earning settles. financial_activity: type: - array - 'null' items: type: object properties: type: type: string enum: - income - expense example: income description: >- Whether the line is income Whop collected or a cost Whop paid. category: type: - string - 'null' description: Fee or cost category of the line. currency: type: string description: Currency of the native amount. amount: type: string description: Line amount in its native currency. amount_usd: type: string description: Line amount in USD. created_at: type: - string - 'null' format: date-time required: - type - category - currency - amount - amount_usd - created_at description: >- Income and cost lines behind this earning's commission. Null for earnings settled before this data was recorded. cancelation_reason: type: - string - 'null' description: >- Why the earning was canceled or reversed, if applicable. created_at: type: string format: date-time payout_at: type: - string - 'null' format: date-time resource: anyOf: - type: - object - 'null' properties: object: type: string enum: - receipt id: type: string currency: type: string payment_method_type: type: - string - 'null' processor: type: - string - 'null' brand: type: - string - 'null' last4: type: - string - 'null' created_at: type: string format: date-time alternative_payment_method: type: - object - 'null' properties: name: type: string image_url: type: - string - 'null' required: - name - image_url required: - object - id - currency - payment_method_type - processor - brand - last4 - created_at - alternative_payment_method - type: 'null' description: The resource that generated the affiliate earning. required: - object - id - account - product - status - transaction_amount_usd - payout_percentage - commission_amount_usd - financial_activity - cancelation_reason - created_at - payout_at - resource page_info: type: object properties: has_next_page: type: boolean end_cursor: type: - string - 'null' has_previous_page: type: boolean start_cursor: type: - string - 'null' required: - has_next_page - end_cursor - has_previous_page - start_cursor required: - data - page_info '400': $ref: '#/components/responses/InvalidParameters' description: invalid sort direction security: - bearerAuth: - referral:basic:read components: parameters: ApiVersionDate: name: Api-Version-Date in: header required: false schema: type: string format: date example: '2026-07-01' description: Pins the request to a dated API version. responses: InvalidParameters: description: Invalid Parameters content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' schemas: V1ErrorResponse: type: object properties: error: type: object properties: type: type: string description: Machine-readable error code. message: type: string description: Human-readable error message. required: - type - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: auth-scheme description: >- An account API key, account scoped JWT, app API key, or user OAuth token. ````