Update a usage rate card

patch/usage-rate-cards/{usage_rate_card_id}
SecuritybearerAuth
Request
path Parameters
usage_rate_card_id
required
integer <int64> (IdParam) >= 1

Usage rate card identifier

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

A set of JSONPatch operations to be performed. Note that usage rates can only be added here. To update or delete a rate, use /usage-rates/ PATCH or DELETE method.

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,
  • "contractOwnerIds": [
    • 1
    ],
  • "name": "string",
  • "rateCardType": "TEMPLATE",
  • "availableFrom": "2019-08-24",
  • "availableTo": "2019-08-24",
  • "usageProductId": 1,
  • "supplierId": 1,
  • "decimalPlaces": 4,
  • "priceRoundingStyle": "UP",
  • "defaultMinCharge": 0,
  • "roundAccessChargeFirstMinute": false,
  • "boltOn": false,
  • "boltOnTaxBandId": 1,
  • "nominalCode": "string",
  • "applyCrossTimeBandCharging": false,
  • "defaultQuantityRoundingIncrement": 1,
  • "defaultVariableChargeUnitSize": 1,
  • "usageRates": [
    • {
      • "id": 1,
      • "chargeGroupId": 1,
      • "usageRateType": "MARKUP",
      • "peakInitialCharge": 0,
      • "peakInitialPeriod": 0,
      • "peakValue": 0,
      • "peakMinimum": 0,
      • "offPeakInitialCharge": 0,
      • "offPeakInitialPeriod": 0,
      • "offPeakValue": 0,
      • "offPeakMinimum": 0,
      • "weekendInitialCharge": 0,
      • "weekendInitialPeriod": 0,
      • "weekendValue": 0,
      • "weekendMinimum": 0,
      • "quantityRoundingIncrement": 1,
      • "variableChargeUnitSize": 1,
      • "surchargeInitialCharge": 0,
      • "surchargeInitialPeriod": 0,
      • "surchargeValue": 0,
      • "surchargeMinimum": 0,
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24"
      }
    ],
  • "timeBandPlans": [
    • {
      • "id": 1,
      • "timeBandPlanId": 1,
      • "name": "string",
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24"
      }
    ],
  • "accessCharges": [
    • {
      • "id": 1,
      • "charge": 0,
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24"
      }
    ],
  • "boltOnCharges": [
    • {
      • "id": 1,
      • "price": 0,
      • "rentalRateType": "ADVANCE",
      • "periodsInAdvance": "STANDARD",
      • "rentalRateFrequency": "DAILY",
      • "showOnInvoice": true,
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24"
      }
    ]
}