Sign in
Partners

List referred business earnings

Lists the earnings Whop pays out for one referred business's activity, most recent first.

get/partners/businesses/{id}/earnings

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"
      },
      "resource": {
        "created_at": "2026-01-01T12:00:00.000Z",
        "currency": "usd",
        "id": "pay_xxxxxxxxxxxxxx",
        "object": "transfer"
      },
      "status": "pending",
      "transaction_amount_usd": "10.00"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 7 of the 74 revisions of this API.312

  • ac2b9b1c6a0012See the full diff
    • ●

      added the new partner_reward enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value partner_reward to the property items/ of the query request parameter income_source

      request-parameter-property-enum-value-added

    • ○

      added subschema #5 to the // response property anyOf list for the response status

      response-property-any-of-added

  • 2d59d2cf94cf12See the full diff
    • ●

      added the new onboarding_reward enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value onboarding_reward to the property items/ of the query request parameter income_source

      request-parameter-property-enum-value-added

    • ○

      added subschema #4 to the // response property anyOf list for the response status

      response-property-any-of-added

  • 4a1a4a5d2c721See the full diff
    • ○

      added the new optional query request parameter income_source

      new-optional-request-parameter

  • a84d4905fdbb2See the full diff
    • ○

      added subschema #1 subschema #2 subschema #3 to the // response property anyOf list for the response status

      response-property-any-of-added

    • ○

      removed subschema #1 subschema #2 subschema #3 from the // response property anyOf list for the response status

      response-property-any-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f1020c3ecda41See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc2See the full diff
    • ○

      added subschema #2 subschema #3 to the // response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3a06a605784b12See the full diff
    • ●

      added the new partner_business_earning enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      api operation id listBusinessReferralEarnings removed and replaced with listPartnerBusinessEarnings

      api-operation-id-removed

    • ○

      removed the business_referral_earning enum value from the // response property for the response status

      response-property-enum-value-removed

Of the 74 revisions, 1 has no diff computed.