Skip to main content
GET
Get commission summary

Authorizations

Authorization
string
header
required

Send Authorization: <ApiKey>:<ApiSecret> — joined by a colon, raw. No Bearer prefix, no base64.

Get your credentials

Query Parameters

month
string

Optional YYYY-MM filter. When provided, totalEarnings/pendingCommissions/processedCommissions/commissionCount are scoped to that month. thisMonthEarnings and lastMonthEarnings always reflect the current and previous calendar months.

Response

Success

totalEarnings
number<double>
required

Everything you have earned, in USD — paid out and not yet paid out.

pendingCommissions
number<double>
required

Earned but not yet paid out, in USD.

processedCommissions
number<double>
required

Already paid out, in USD.

thisMonthEarnings
number<double>
required

Earned this calendar month, in USD. Not affected by the month filter.

lastMonthEarnings
number<double>
required

Earned last calendar month, in USD. Not affected by the month filter.

commissionCount
number<double>
required

How many commission entries are included.