Skip to main content
GET
/
referrals
/
businesses
/
{id}
/
earnings
List a business referral's earnings
curl --request GET \
  --url https://{defaultHost}/referrals/businesses/{id}/earnings \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "object": "business_referral_earning",
      "id": "<string>",
      "account": {
        "id": "<string>",
        "title": "<string>",
        "logo_url": "<string>",
        "route": "<string>"
      },
      "product": {
        "id": "<string>",
        "title": "<string>",
        "route": "<string>"
      },
      "status": "pending",
      "transaction_amount_usd": "<string>",
      "payout_percentage": 123,
      "commission_amount_usd": "<string>",
      "financial_activity": [
        {
          "type": "income",
          "category": "<string>",
          "currency": "<string>",
          "amount": "<string>",
          "amount_usd": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "cancelation_reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "payout_at": "2023-11-07T05:31:56Z",
      "resource": {
        "object": "receipt",
        "id": "<string>",
        "currency": "<string>",
        "payment_method_type": "<string>",
        "processor": "<string>",
        "brand": "<string>",
        "last4": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "alternative_payment_method": {
          "name": "<string>",
          "image_url": "<string>"
        }
      }
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "<string>",
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Headers

Api-Version-Date
string<date>

Pins the request to a dated API version.

Example:

"2026-07-01"

Path Parameters

id
string
required

The business referral 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