Partners

List referred business earnings

Changed on

Lists the earnings Whop pays out for one referred business's activity, most recent first. The original referrer or a caller with company:basic:read on the business credited for the referral can read them.

get/partners/businesses/{id}/earnings

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/partners/businesses/{id}/earnings
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

status'awaiting_settlement' | 'pending' | 'completed' | 'canceled' | 'reversed'

Filter by earning status.

income_sourcestring[]

Filter to earnings from these income sources. Repeat the parameter for each one (income_source=sales&income_source=ad_spend).

[
  "sales"
]
firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order'created_at' | 'commission_amount' | 'transaction_amount' | 'payout_at'

The field to sort earnings by.

direction'asc' | 'desc'

Sort direction.

created_beforestring

Only return earnings created before this timestamp.

created_afterstring

Only return earnings created after this timestamp.

Response

earnings listed

Example response

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "route": "biz_xxxxxxxxxxxxxx",
        "title": "Gleam Mobile Detailing"
      },
      "cancelation_reason": "payment_refunded",
      "commission_amount_usd": "1.00",
      "created_at": "2026-01-01T12:00:00.000Z",
      "financial_activity": [
        {
          "amount": "3.00",
          "amount_usd": "3.00",
          "category": "whop_processing_fee",
          "created_at": "2026-01-01T12:00:00.000Z",
          "currency": "usd",
          "type": "income"
        }
      ],
      "id": "afpy_xxxxxxxxxxxxxx",
      "income_source": "sales",
      "object": "partner_business_earning",
      "payout_at": "2026-01-01T12:00:00.000Z",
      "payout_percentage": 0.04,
      "product": {
        "id": "prod_xxxxxxxxxxxxxx",
        "route": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "title": "Ceramic Coating Package"
      },
      "projected_commission_amount_usd": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "resource": {
        "alternative_payment_method": {
          "image_url": "https://content.whop.com/core/pm_cashapp.svg",
          "name": "Cash App"
        },
        "brand": "visa",
        "created_at": "2026-01-01T12:00:00.000Z",
        "currency": "usd",
        "id": "pay_xxxxxxxxxxxxxx",
        "last4": "4242",
        "object": "receipt",
        "payment_method_type": "card",
        "processor": "stripe"
      },
      "status": "pending",
      "transaction_amount_usd": "10.00"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • 513e62e6d7e0Revision changes
    • info

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope company:basic:read was removed from the endpoint's security scheme bearerAuth

  • 27649ab2b67aRevision changes
    • info

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope company:basic:read was removed from the endpoint's security scheme bearerAuth