Skip to main content
GET
List the affiliate referrals

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:100

Maximum rows returned.

Required range: 1 <= x <= 200

Response

Successful Response

clawed_back_cents
integer
required

What refunds and disputes took back off it, as a positive magnitude.

commission_months
integer
required

How many months this referral pays commission for.

commission_rate_bps
integer
required

The rate stamped on THIS referral, which the program's current offer does not change.

commission_window_ends_at
string<date-time> | null
required

When this referral stops earning; null until it converts.

converted_at
string<date-time> | null
required

When this referral first started paying; null while still on the free plan.

earned_cents
integer
required

Gross commission this referral has produced.

id
string<uuid>
required
last_payment_at
string<date-time> | null
required
payment_count
integer
required

How many commission payments it has produced.

signed_up_at
string<date-time>
required
source
string
required

The link tag this referral arrived under, if any.