Patch update inclusive usage plan

patch/inclusive-usage-plans/{inclusive_usage_plan_id}
SecuritybearerAuth
Request
path Parameters
inclusive_usage_plan_id
required
integer <int64> (IdParam) >= 1

Inclusive usage plan identifier

Example: 1
Request Body schema: application/json-patch+json

A set of JSONPatch operations to be performed

Array
op
required
string

The JSON Patch operation to be performed

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations

from
string

A string containing a JSON Pointer value

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Request samples
application/json-patch+json
[
  • {
    • "op": "add",
    • "path": "string",
    • "value": { },
    • "from": "string"
    }
]
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
}