Skip to main content
GET
List a partner's referred business earnings

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-08-1"

Path Parameters

id
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
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
page_info
object
required