# Get a list of available inclusive usage plans

Endpoint: GET /inclusive-usage-plans
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"

  - `contractOwnerId` (string)
    Filter by contract Owner
    Example: "0"

  - `name` (string)
    Filter by name
    Example: "xyz | in:x,y | like:xyz"

  - `availableFrom` (string)
    Filter by available from date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `availableTo` (string)
    Filter by available to date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `usageProductId` (string)
    Filter by usage product
    Example: "0"

  - `taxBandId` (string)
    Filter by tax band
    Example: "0"

## Header parameters:

  - `summary` (string)
    If true, returns a lightweight summary of each inclusive usage plan instead of the full object. Use this to reduce payload size and improve performance when only basic information is needed.
    Example: "true | false"

## Response 200 fields (application/json):

  - `id` (integer)
    Inclusive usage plan identifier
    Example: 1

  - `contractOwnerId` (integer, required)
    Contract owner identifier
    Example: 1

  - `name` (string, required)
    Inclusive usage plan name

  - `usageProductId` (integer, required)
    Usage product identifier
    Example: 1

  - `availableFrom` (string, required)
    Available from date

  - `availableTo` (string)
    Available to date

  - `boltOn` (boolean)
    Bolt on flag

  - `taxBandId` (integer)
    Tax band identifier

  - `nominalCode` (string)
    Nominal code
    Example: "SALES-01QTR2"

  - `inclusiveUsageComponents` (array)

  - `inclusiveUsageComponents.id` (integer)
    Inclusive usage identifier
    Example: 1

  - `inclusiveUsageComponents.description` (string, required)
    The description of the component

  - `inclusiveUsageComponents.componentType` (string, required)
    The type for a component
    Enum: "VALUE", "QUANTITY"

  - `inclusiveUsageComponents.chargingType` (string)
    The charging type of the component. Required if componentType is set to QUANTITY
    Enum: "DURATION", "MB", "ONE_OFF"

  - `inclusiveUsageComponents.quantity` (integer, required)
    The charging quantity to use. Used if the component type is set to QUANTITY, and is relative to the charging type (i.e. in Seconds if DURATION, in Megabytes if MB)

  - `inclusiveUsageComponents.valueInPence` (integer)
    The value in pence. Used if the component type is set to VALUE

  - `inclusiveUsageComponents.timebands` (array, required)

  - `inclusiveUsageComponents.timebands.id` (integer)
    Inclusive usage to time band identifier
    Example: 1

  - `inclusiveUsageComponents.timebands.timeband` (string, required)
    A definition of timebands to be used. Primarily used in Inclusive Usage plans
    Enum: "PEAK", "OFFPEAK", "WEEKEND"

  - `inclusiveUsageComponents.chargeGroups` (array)

  - `inclusiveUsageComponents.chargeGroups.id` (integer)
    Inclusive usage to charge group identifier
    Example: 1

  - `inclusiveUsageComponents.chargeGroups.chargeGroupId` (integer, required)
    the charge group ID

  - `inclusiveUsageComponents.chargeGroupCategories` (array)

  - `inclusiveUsageComponents.chargeGroupCategories.id` (integer)
    Inclusive usage to charge group category identifier
    Example: 1

  - `inclusiveUsageComponents.chargeGroupCategories.chargeGroupCategoryId` (integer, required)
    the charge group category ID

  - `inclusiveUsageComponents.dialStrings` (array)

  - `inclusiveUsageComponents.dialStrings.id` (integer)
    Inclusive usage to dial string identifier
    Example: 1

  - `inclusiveUsageComponents.dialStrings.dialString` (string, required)
    The dial string to be used

  - `inclusiveUsageComponents.dialStrings.isWholeNumber` (boolean, required)
    Whether the dial string should match completely against a call, or whether the string can be used for digit-tree analysis

  - `boltOnCharges` (array)

  - `boltOnCharges.id` (integer)
    Bolt on pricing identifier
    Example: 1

  - `boltOnCharges.price` (number, required)

  - `boltOnCharges.rentalRateType` (string, required)
    Rental rate type. Required when rentalRatePriceType is RENTAL
    Enum: "ADVANCE", "ARREARS"

  - `boltOnCharges.periodsInAdvance` (string)
    Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE
    Enum: "STANDARD", "ADVANCEDPLUSONEMONTH"

  - `boltOnCharges.rentalRateFrequency` (string, required)
    Frequency of rental. Required when rentalRatePriceType is RENTAL
    Enum: "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "QUARTERLY", "SIXMONTHS", "TWENTYFOURMONTHS"

  - `boltOnCharges.showOnInvoice` (boolean, required)
    Whether to show the bolt-on on the invoice

  - `boltOnCharges.startDate` (string, required)
    Start date

  - `boltOnCharges.endDate` (string)
    End date

  - `rolloverPeriods` (integer)
    Roll over period

  - `triggerChargeId` (integer)
    The first qualifying inclusive usage event will trigger a charge using the selected rental product (an RPI will be created). If the allowance is used up, the next qualifying event will trigger another charge
    Example: 1

  - `supplierAccountId` (integer)
    The supplier account associated with the triggered rental product based on the rental product's supplier (required when trigger charge is set)
    Example: 1

  - `frequency` (string)
    Frequency or period for the inclusive usage plan. This can be daily, weekly or monthly (required when trigger charge is set)
    Enum: "MONTHLY", "DAILY", "WEEKLY"

  - `minQualifyingQuantity` (number)
    If required, specify the minimum quantity required for an event to qualify for deduction from the inclusive usage allowance. E.g. rate events as normal if the qty is less than this value but deduct from the allowance if equal to or greater than this value. Only applicable for inclusive usage components that are quantity based (duration/megabyte/one-off)

  - `maxPerEventQuantity` (number)
    Events over this quantity will be split such that the first part of the event is deducted from the inclusive usage allowance while the latter part is rated as normal. Leave this value as "0" to ignore this functionality and qualify the whole event for inclusive usage rating


## Response 400 fields

## Response 401 fields

## Response 403 fields