Create a new inclusive usage plan

post/inclusive-usage-plans
SecuritybearerAuth
Request
Request Body schema: application/json

New Inclusive Usage Plan

contractOwnerId
required
integer <int32>

Contract owner identifier

name
required
string [ 1 .. 100 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Inclusive usage plan name

usageProductId
required
integer <int64>

Usage product identifier

availableFrom
required
string <date>

Available from date

availableTo
string <date>

Available to date

boltOn
boolean
Default: false

Bolt on flag

taxBandId
integer <int64>

Tax band identifier

nominalCode
string [ 1 .. 50 ] characters [a-zA-Z0-9\\p{L}.\\-_]*

Nominal code

Array of objects (InclusiveUsage)
Array of objects (InclusiveUsageBoltOnCharge)
rolloverPeriods
integer <int64>

Roll over period

triggerChargeId
integer <int64>

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.

supplierAccountId
integer <int64>

The supplier account associated with the triggered rental product based on the rental product's supplier (required when trigger charge is set).

frequency
string (InclusiveUsageFrequency)

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.

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "contractOwnerId": 1,
  • "name": "string",
  • "usageProductId": 1,
  • "availableFrom": "2019-08-24",
  • "availableTo": "2019-08-24",
  • "boltOn": false,
  • "taxBandId": 0,
  • "nominalCode": "string",
  • "inclusiveUsageComponents": [
    • {
      • "description": "string",
      • "componentType": "VALUE",
      • "chargingType": "DURATION",
      • "quantity": 0,
      • "valueInPence": 0,
      • "timebands": [
        • {
          • "timeband": "PEAK"
          }
        ],
      • "chargeGroups": [
        • {
          • "chargeGroupId": 0
          }
        ],
      • "chargeGroupCategories": [
        • {
          • "chargeGroupCategoryId": 0
          }
        ],
      • "dialStrings": [
        • {
          • "dialString": "string",
          • "isWholeNumber": true
          }
        ]
      }
    ],
  • "boltOnCharges": [
    • {
      • "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
}
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
}