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

Endpoint: GET /inclusive-usage-balances
Version: 2.21
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `customerId` (string)
    Filter by customer id
    Example: "0"

  - `siteId` (string)
    Filter by site id
    Example: "0"

  - `usageProductInventoryId` (string)
    Filter by usage product inventory id
    Example: "0"

  - `billRunId` (string)
    Filter by bill run id
    Example: "0"

  - `assignmentId` (string)
    Filter by inclusive usage plan assignment id
    Example: "0"

  - `inclusiveUsagePlanId` (string)
    Filter by inclusive usage plan id
    Example: "0"

  - `componentId` (string)
    Filter by inclusive usage component id
    Example: "0"

## Response 200 fields (application/json):

  - `billRunId` (integer)
    bill run identifier

  - `periodStartDate` (string)
    bill run start date
    Example: "2025-09-01"

  - `periodEndDate` (string)
    bill run start date
    Example: "2025-09-30"

  - `usageProductInventoryId` (integer)
    usage product inventory identifier

  - `inclusiveUsageBalanceAssignments` (array)
    assignments for this balance

  - `inclusiveUsageBalanceAssignments.assignmentId` (integer)
    inclusive usage assignment identifier

  - `inclusiveUsageBalanceAssignments.assignmentLevel` (string)
    assignment level
    Enum: "CUSTOMER", "SITE", "INVENTORY"

  - `inclusiveUsageBalanceAssignments.assignmentStartDate` (string)
    Inclusive usage assignment start date
    Example: "2025-01-01"

  - `inclusiveUsageBalanceAssignments.assignmentEndDate` (string)
    Inclusive usage assignment end date

  - `inclusiveUsageBalanceAssignments.inclusiveUsagePlanId` (integer)
    inclusive usage plan identifier

  - `inclusiveUsageBalanceAssignments.components` (array)
    components for this balance assignment

  - `inclusiveUsageBalanceAssignments.components.componentId` (integer)
    inclusive usage component identifier

  - `inclusiveUsageBalanceAssignments.components.byValue` (boolean)
    Whether the allowance is defined by value rather than quantity

  - `inclusiveUsageBalanceAssignments.components.chargingType` (string)
    Charging unit i.e. duration or data (MB) or one off
    Enum: "DURATION", "MB", "ONE_OFF"

  - `inclusiveUsageBalanceAssignments.components.allowance` (integer)
    Original allowance for this component
    Example: 1000

  - `inclusiveUsageBalanceAssignments.components.remaining` (integer)
    Remaining balance in this component
    Example: 500

  - `inclusiveUsageBalanceAssignments.components.startDate` (string)
    Start of the allowance period
    Example: "2025-08-01 00:00:00"

  - `inclusiveUsageBalanceAssignments.components.endDate` (string)
    End of the allowance period
    Example: "2025-08-31 11:59:59"


## Response 400 fields

## Response 401 fields

## Response 403 fields