customerCommissionRates

Requires permission commissions:commission:read.

Lists the commission rates set for specific customers. A rep, or a manager's subtree, sees only the customers in their own book. Requires permission to read commissions.

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 CustomerCommissionRates {
  customerCommissionRates {
    id
    customerName
    isActive
    partnerId
    rate
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerCommissionRates {\n  customerCommissionRates {\n    id\n    customerName\n    isActive\n    partnerId\n    rate\n  }\n}"
}
EOF

Response:

{
  "data": {
    "customerCommissionRates": [
      {
        "id": "id",
        "customerName": "string",
        "isActive": true,
        "partnerId": "string",
        "rate": 0
      }
    ]
  }
}

customerCommissionRates: [CustomerCommissionRate!]!

Type

CustomerCommissionRate object

A commission rate set for one customer.