Referrals

List Referral Payouts

Returns the monthly referral commission payouts the creator has received — one row per disbursement. Same shape as /payouts/requests but scoped to referral commissions, not earnings withdrawals. Requires permission api_referrals_list_payouts.

https://public-api.fansmetric.com

GET/v1/{account_id}/referrals/payouts

API keyBearer

Authorization

default

AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Path Parameters

account_id*integer
OnlyFans numeric account ID.

Query Parameters

start_datestring
Lower bound on createdAt. Default 2 years ago, UTC.
end_datestring
Upper bound on createdAt. Default end of today, UTC.
offsetinteger
Rows to skip. Page size is fixed at 10.
markerstring
Snapshot pin (unix seconds) from a prior response. Omit on the first page; pass back unchanged on subsequent pages.

Response Fields

data.list[]array
Referral payouts in this page, newest first.
data.list[].invoiceIdstring
OnlyFans invoice ID for this referral payout.
data.list[].createdAtstring
ISO 8601 timestamp of the payout. Referral commissions are paid monthly, so createdAt typically clusters on the 1st.
data.list[].amountnumber
Amount paid in currency units.
data.list[].currencystring
ISO 4217 currency code.
data.list[].statestring
Approval state. Observed: approved. Other expected values: pending, rejected, processing.
data.list[].rejectReasonstring|null
Reject reason when state == "rejected". null otherwise.
data.markerinteger
Snapshot pin (unix seconds). Pass back on subsequent requests.
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_pagination.next_pagestring
Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_meta._credits.usedinteger
Credits consumed by this request (currently always 1).
_meta._rate_limits.limit_minuteinteger
Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteinteger
Remaining requests in the current minute window.
_meta._rate_limits.limit_dayinteger
Maximum requests per day for the organization.
_meta._rate_limits.remaining_dayinteger
Remaining requests in the current day window.

Field	Type	Description
data.list[]	array	Referral payouts in this page, newest first.
data.list[].invoiceId	string	OnlyFans invoice ID for this referral payout.
data.list[].createdAt	string	ISO 8601 timestamp of the payout. Referral commissions are paid monthly, so `createdAt` typically clusters on the 1st.
data.list[].amount	number	Amount paid in `currency` units.
data.list[].currency	string	ISO 4217 currency code.
data.list[].state	string	Approval state. Observed: `approved`. Other expected values: `pending`, `rejected`, `processing`.
data.list[].rejectReason	string\|null	Reject reason when `state == "rejected"`. `null` otherwise.
data.marker	integer	Snapshot pin (unix seconds). Pass back on subsequent requests.
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_pagination.next_page	string	Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_meta._credits.used	integer	Credits consumed by this request (currently always `1`).
_meta._rate_limits.limit_minute	integer	Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minute	integer	Remaining requests in the current minute window.
_meta._rate_limits.limit_day	integer	Maximum requests per day for the organization.
_meta._rate_limits.remaining_day	integer	Remaining requests in the current day window.

curl --request GET "https://public-api.fansmetric.com/v1/100000001/referrals/payouts?start_date=2026-01-01%2000%3A00%3A00&end_date=2026-01-31%2023%3A59%3A59&offset=0" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"list":[0:{"invoiceId":"240825"
"createdAt":"2026-05-01T15:58:51+00:00"
"amount":739
"currency":"USD"
"state":"approved"
"rejectReason":null
}
]
"marker":1779974137
}
"_pagination":{"next_page":null
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Get Referral Balance

Get Referral Payouts Chart