Get a list of available inclusive usage plans

get/inclusive-usage-plans
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
contractOwnerId
string (IdFilterParam)

Filter by contract Owner

Example: contractOwnerId=0
name
string (StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
availableFrom
string (DateFilterParam)

Filter by available from date

Example: availableFrom=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
availableTo
string (DateFilterParam)

Filter by available to date

Example: availableTo=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
usageProductId
string (IdFilterParam)

Filter by usage product

Example: usageProductId=0
taxBandId
string (IdFilterParam)

Filter by tax band

Example: taxBandId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "contractOwnerId": 1,
    • "name": "string",
    • "usageProductId": 1,
    • "availableFrom": "2019-08-24",
    • "availableTo": "2019-08-24",
    • "boltOn": false,
    • "taxBandId": 0,
    • "nominalCode": "string",
    • "inclusiveUsageComponents": [
      • {
        • "id": 1,
        • "description": "string",
        • "componentType": "VALUE",
        • "chargingType": "DURATION",
        • "quantity": 0,
        • "valueInPence": 0,
        • "timebands": [
          • {
            • "id": 1,
            • "timeband": "PEAK"
            }
          ],
        • "chargeGroups": [
          • {
            • "id": 1,
            • "chargeGroupId": 0
            }
          ],
        • "chargeGroupCategories": [
          • {
            • "id": 1,
            • "chargeGroupCategoryId": 0
            }
          ],
        • "dialStrings": [
          • {
            • "id": 1,
            • "dialString": "string",
            • "isWholeNumber": true
            }
          ]
        }
      ],
    • "boltOnCharges": [
      • {
        • "id": 1,
        • "price": 0,
        • "rentalRateType": "ADVANCE",
        • "periodsInAdvance": "STANDARD",
        • "rentalRateFrequency": "DAILY",
        • "showOnInvoice": true,
        • "startDate": "2019-08-24",
        • "endDate": "2019-08-24"
        }
      ],
    • "rolloverPeriods": 0,
    • "triggerChargeId": 1,
    • "supplierAccountId": 1,
    • "frequency": "MONTHLY",
    • "minQualifyingQuantity": 0,
    • "maxPerEventQuantity": 0
    }
]