Create a new usage rate override

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

New usage rate override

assignmentLevel
required
string

Rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required.

usageProductId
required
integer <int64>

Usage product identifier

supplierId
integer <int64>

Supplier identifier

chargeGroupId
required
integer <int64>

Charge group identifier

variableChargeUnitSize
required
integer <int32> >= 1

Variable charge unit size

quantityRoundingIncrement
required
number >= 1

Quantity rounding increment

startDate
required
string <date>

Start date

appliesToISDNOnly
boolean
Default: false

Applies to ISDN calls only?

endDate
string <date>

End date

peakValue
number

Peak value

offPeakValue
number

Off peak value

weekendValue
number

Weekend value

peakMinimumCharge
required
number

Peak minimum charge

offPeakMinimumCharge
required
number

Off peak minimum charge

weekendMinimumCharge
required
number

Weekend minimum charge

peakInitialCharge
required
number

Peak initial charge

offPeakInitialCharge
required
number

Off peak initial charge

weekendInitialCharge
required
number

Weekend initial charge

peakInitialChargePeriod
required
integer <int32>

Peak initial charge period

offPeakInitialChargePeriod
required
integer <int32>

Off peak initial charge period

weekendInitialChargePeriod
required
integer <int32>

Weekend initial charge period

customerId
required
integer <int64>

Customer identifier

applyThisToChildren
required
boolean
Default: true

Apply this override to children?

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Request samples
application/json
{
  • "assignmentLevel": "CUSTOMER",
  • "usageProductId": 1,
  • "supplierId": 1,
  • "chargeGroupId": 1,
  • "variableChargeUnitSize": 60,
  • "quantityRoundingIncrement": 1,
  • "startDate": "2019-08-24",
  • "appliesToISDNOnly": false,
  • "endDate": "2019-08-24",
  • "peakValue": 0,
  • "offPeakValue": 0,
  • "weekendValue": 0,
  • "peakMinimumCharge": 0,
  • "offPeakMinimumCharge": 0,
  • "weekendMinimumCharge": 0,
  • "peakInitialCharge": 0,
  • "offPeakInitialCharge": 0,
  • "weekendInitialCharge": 0,
  • "peakInitialChargePeriod": 0,
  • "offPeakInitialChargePeriod": 0,
  • "weekendInitialChargePeriod": 0,
  • "customerId": 1,
  • "applyThisToChildren": true
}
Response samples
application/json
{
  • "id": 1,
  • "assignmentLevel": "CUSTOMER",
  • "usageProductId": 1,
  • "supplierId": 1,
  • "chargeGroupId": 1,
  • "variableChargeUnitSize": 60,
  • "quantityRoundingIncrement": 1,
  • "startDate": "2019-08-24",
  • "appliesToISDNOnly": false,
  • "endDate": "2019-08-24",
  • "peakValue": 0,
  • "offPeakValue": 0,
  • "weekendValue": 0,
  • "peakMinimumCharge": 0,
  • "offPeakMinimumCharge": 0,
  • "weekendMinimumCharge": 0,
  • "peakInitialCharge": 0,
  • "offPeakInitialCharge": 0,
  • "weekendInitialCharge": 0,
  • "peakInitialChargePeriod": 0,
  • "offPeakInitialChargePeriod": 0,
  • "weekendInitialChargePeriod": 0,
  • "customerId": 1,
  • "applyThisToChildren": true
}