v9

OpenAPI 3.1.02026-08-043703845.2 MB

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.

firstinteger

afterstring

lastinteger

beforestring

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": [
    {
      "financial_activity": [
        {
          "type": "income"
        }
      ],
      "income_source": "sales",
      "status": "pending"
    }
  ]
}