Skip to main content
GET
/
api
/
v1
/
members
/
{userId}
/
commissions
/
breakdown
Get commission breakdown
curl --request GET \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/commissions/breakdown \
  --header 'x-tenant-api-key: <api-key>'
{
  "totalAmount": 123,
  "bySource": {
    "sales": 123,
    "subscription": 123
  },
  "byStatus": {
    "pending": 123,
    "cleared": 123,
    "processing": 123,
    "paid": 123
  },
  "byLevel": [
    {
      "level": 123,
      "amount": 123,
      "count": 123,
      "percentage": 123
    }
  ],
  "trend": [
    {
      "period": "<string>",
      "amount": 123,
      "count": 123
    }
  ]
}

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication

Path Parameters

userId
string<uuid>
required

Query Parameters

period
string

Period in YYYY-MM format or 'all'

Response

Commission breakdown

totalAmount
number
bySource
object
byStatus
object
byLevel
object[]
trend
object[]