Provides the remaining inclusive usage values — such as duration, data, or one-off events

get/inclusive-usage-balances
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
customerId
string (IdFilterParam)

Filter by customer id

Example: customerId=0
siteId
string (IdFilterParam)

Filter by site id

Example: siteId=0
usageProductInventoryId
string (IdFilterParam)

Filter by usage product inventory id

Example: usageProductInventoryId=0
billRunId
string (IdFilterParam)

Filter by bill run id

Example: billRunId=0
assignmentId
string (IdFilterParam)

Filter by inclusive usage plan assignment id

Example: assignmentId=0
inclusiveUsagePlanId
string (IdFilterParam)

Filter by inclusive usage plan id

Example: inclusiveUsagePlanId=0
componentId
string (IdFilterParam)

Filter by inclusive usage component id

Example: componentId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "billRunId": 0,
    • "periodStartDate": "2025-09-01",
    • "periodEndDate": "2025-09-30",
    • "usageProductInventoryId": 0,
    • "inclusiveUsageBalanceAssignments": [
      • {
        • "assignmentId": 0,
        • "assignmentLevel": "CUSTOMER",
        • "assignmentStartDate": "2025-01-01",
        • "assignmentEndDate": null,
        • "inclusiveUsagePlanId": 0,
        • "components": [
          • {
            • "componentId": 0,
            • "byValue": true,
            • "chargingType": "DURATION",
            • "allowance": 1000,
            • "remaining": 500,
            • "startDate": "2025-08-01 00:00:00",
            • "endDate": "2025-08-31 11:59:59"
            }
          ]
        }
      ]
    }
]