Create a new usage rate card

post/usage-rate-cards
SecuritybearerAuth
Request
Request Body schema: application/json

New usage rate card

contractOwnerIds
required
Array of integers <int32>

Contract owner identifiers

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

Usage rate card name

rateCardType
required
string (UsageRateCardType)
Default: "SELL"

Usage rate card type. Buy = used to price usage purchased from the supplier, Sell = used to price usage sold to customers, Template = is a rate card to which other rate cards can be linked

Enum: "TEMPLATE" "SELL" "BUY"
availableFrom
required
string <date>

Available from date

availableTo
string <date>

Available to date

usageProductId
required
integer <int64>

Usage product identifier

supplierId
integer <int64>

Supplier identifier

decimalPlaces
required
integer <int32>

Number of decimal places. In the context of pence this defines the precision to which usage prices will be calculated. For example, a value of 4 would result in prices being calculated to 4 decimal places (1.0045 pence)

priceRoundingStyle
required
string (PriceRoundingStyle)
Default: "MATHEMATICAL"

Price rounding style. When pricing usage, each call will be rounded to the specified number of decimal places using the method selected here

Enum: "UP" "DOWN" "MATHEMATICAL"
defaultMinCharge
required
number

Default minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence would be charged at 5 pence if this value was set to 5 pence. This default value can be overridden at Charge Group level.

roundAccessChargeFirstMinute
boolean
Default: false

Round access charge for first minute. When pricing using access charges round the first minute of the call.

boltOn
boolean
Default: false

Bolt on enabled. A bolt on is a usage rate card that incurs a recurring charge (typically a monthly charge provides access to discounted call rates).

boltOnTaxBandId
integer <int64>

Tax band identifier for bolt on charges (required when bolt on enabled)

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

Nominal code

applyCrossTimeBandCharging
boolean
Default: false

Apply cross time band charging. Where a call crosses multiple time bands this option allows the different portions of the call to be charged at either peak or off-peak rates as required. If this option is not selected then the entire call will be charged using the rate applicable at the start of the call.

defaultQuantityRoundingIncrement
integer <int32>

Default quantity rounding increment. The chargeable quantity (seconds or megabytes) will be rounded up to the nearest multiple of this value. For example, a 61 second call would be rounded up to 120 seconds if this value is set to an increment of 60. This default value can be overridden at Charge Group level.

defaultVariableChargeUnitSize
integer <int32>

Default variable charge unit size. The unit size in which charges will be calculated. For example, if this value is 60 seconds then the charge is pence per minute; if this value is 1024 MB then the charge is pence per gigabyte. This default value can be overridden at Charge Group level.

Array of objects (UsageRate)
Array of objects (UsageRateTimeBandPlan)
Array of objects (UsageRateAccessCharge)
Array of objects (UsageRateCardBoltOnCharge)
Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "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": [
    • {
      • "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": [
    • {
      • "timeBandPlanId": 1,
      • "name": "string",
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24"
      }
    ],
  • "accessCharges": [
    • {
      • "charge": 0,
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24"
      }
    ],
  • "boltOnCharges": [
    • {
      • "price": 0,
      • "rentalRateType": "ADVANCE",
      • "periodsInAdvance": "STANDARD",
      • "rentalRateFrequency": "DAILY",
      • "showOnInvoice": true,
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24"
      }
    ]
}
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"
      }
    ]
}