List referred business earnings

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const earningListResponse of client.partners.businesses.earnings.list('id')) {
  console.log(earningListResponse.id);
}

import requests

url = "https://api.whop.com/api/v1/partners/businesses/{id}/earnings"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/partners/businesses/{id}/earnings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/partners/businesses/{id}/earnings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/partners/businesses/{id}/earnings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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": {
        "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"
      },
      "second_tier": false,
      "status": "pending",
      "transaction_amount_usd": "10.00"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

partners

businesses

{id}

earnings

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const earningListResponse of client.partners.businesses.earnings.list('id')) {
  console.log(earningListResponse.id);
}

import requests

url = "https://api.whop.com/api/v1/partners/businesses/{id}/earnings"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/partners/businesses/{id}/earnings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/partners/businesses/{id}/earnings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/partners/businesses/{id}/earnings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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": {
        "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"
      },
      "second_tier": false,
      "status": "pending",
      "transaction_amount_usd": "10.00"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

string

required

The partner business ID (a coma_ identifier).

Query Parameters

status

enum<string>

Filter by earning status.

Available options:

awaiting_settlement,

pending,

completed,

canceled,

reversed

income_source

enum<string>[]

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

Available options:

sales,

ad_spend,

transfer,

card_interchange

first

integer

default:20

Required range: x <= 100

after

string

last

integer

Required range: x <= 100

before

string

order

enum<string>

default:created_at

The field to sort earnings by.

Available options:

created_at,

commission_amount,

transaction_amount,

payout_at

direction

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

created_before

string

Only return earnings created before this timestamp.

created_after

string

Only return earnings created after this timestamp.

Response

earnings listed

data

object[]

required

Show child attributes

page_info

object

required

Show child attributes

⌘I

Introduction

Reference

Webhooks & events

Core Resources

Notifications

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

List referred business earnings

Authorizations

Headers

Path Parameters

Query Parameters

Response