myCommissionSummary

Requires an authenticated session.

Returns the signed-in user's own commission totals: this month's pending and paid, and lifetime earned, paid and outstanding.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query MyCommissionSummary {
  myCommissionSummary {
    defaultRate
    lastMonthTotal
    lastPayoutDate
    lifetimeEarned
    lifetimeOutstanding
    lifetimePaid
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query MyCommissionSummary {\n  myCommissionSummary {\n    defaultRate\n    lastMonthTotal\n    lastPayoutDate\n    lifetimeEarned\n    lifetimeOutstanding\n    lifetimePaid\n  }\n}"
}
EOF

Response:

{
  "data": {
    "myCommissionSummary": {
      "defaultRate": 0,
      "lastMonthTotal": 0,
      "lastPayoutDate": "2025-01-15T00:00:00Z",
      "lifetimeEarned": 0,
      "lifetimeOutstanding": 0,
      "lifetimePaid": 0
    }
  }
}

myCommissionSummary: CommissionSummary!

Type

CommissionSummary object

A rep's commission figures.