Skip to main content
GET
/
referrals
/
businesses
/
{id}
Retrieve a business referral
curl --request GET \
  --url https://{defaultHost}/referrals/businesses/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "business_referral",
  "id": "<string>",
  "account": {
    "id": "<string>",
    "title": "<string>",
    "logo_url": "<string>",
    "route": "<string>"
  },
  "payout_percentage": 123,
  "referred_by_account_id": "<string>",
  "referral_started_at": "2023-11-07T05:31:56Z",
  "referral_expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "processing_volume": 123,
  "total_earnings": 123,
  "pending_payout": 123,
  "completed_payout": 123
}

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. When omitted, the request uses the original (2025-01-01) request/response shapes, so existing unversioned callers are never broken. Generated SDKs always send the latest version they were built against. An unrecognized value is rejected with a 400. The schemas documented here always describe the latest version.

Example:

"2026-06-09"

Path Parameters

​
id
string
required

The business referral ID (a coma_ identifier).

Response

business referral retrieved

​
object
enum<string>
required
Available options:
business_referral
​
id
string
required
​
account
object
required
​
status
enum<string>
required
Available options:
active,
removed
​
payout_percentage
number<float>
required
​
referred_by_account_id
string | null
required

The company that made the referral, if a company referred.

​
referral_started_at
string<date-time> | null
required
​
referral_expires_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
currency
string
required
​
processing_volume
number<float>
required

All-time gross processing volume for the business, in USD.

​
total_earnings
number<float>
required

All-time affiliate earnings from this business (pending + completed), in USD.

​
pending_payout
number<float>
required

Earnings awaiting payout, in USD.

​
completed_payout
number<float>
required

Earnings already paid out, in USD.