Usage rate cards represent the pricing structure for usage products that can be sold to Customers
/
Delete a specific usage r...
Elevate Pricing API (2.21)
Provides read & write access to usage and rental rate cards and inclusive usage plans
- Usage Rate Card - a representation of the pricing structure for usage that can be sold to Customers, for example 5 pence per minute for UK National calls
- Rental Rate Card - a representation of the pricing structure for rental product that can be sold to Customers, for example £10 per month for line rental
- Inclusive Usage Plan - a representation of an inclusive bundle that can be sold to a Customer, for example you can allocate 500 free minutes to UK National or Local calls
Download OpenAPI description
Languages
Servers
https://rest.elevatebilling.com/v2
Query
Results to return per page
Example: pageSize=100
Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
Example: sort=id,name | name:desc
Comma-delimited list of the field(s) to return if only a subset is required
Example: fields=id,name
Filter by available from date
Example: availableFrom=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
Filter by available to date
Example: availableTo=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
Filter by rate card type
Example: rateCardType=xyz | in:x,y | like:xyz
- https://rest.elevatebilling.com/v2/usage-rate-cards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v2/usage-rate-cards?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&contractOwnerId=0&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&availableFrom=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&availableTo=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&rateCardType=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&usageProductId=0&supplierId=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'summary: true | false'OK
The billing entity or entities that will have access to this item. This is a multi-select field. If there is only one existing contractOwnerId, you can replace it with another regardless of currency. However, if there are multiple contractOwnerIds, any new or replacement contractOwnerIds must use the same currency as the existing contractOwnerId(s). Different currencies cannot be mixed
Example: [1]
Usage rate card name
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
Default "SELL"
Enum"TEMPLATE""SELL""BUY"
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)
Example: 4
Price rounding style. When pricing usage, each call will be rounded to the specified number of decimal places using the method selected here
Default "MATHEMATICAL"
Enum"UP""DOWN""MATHEMATICAL"
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
Round access charge for first minute. When pricing using access charges round the first minute of the call
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)
Default false
Tax band identifier for bolt on charges (required when bolt on enabled)
Example: 1
Nominal code
Example: "SALES-01QTR2"
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
Default false
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
Example: 1
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
Example: 1
Response
application/json
[ { "id": 1, "contractOwnerIds": [ … ], "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": "SALES-01QTR2", "applyCrossTimeBandCharging": false, "defaultQuantityRoundingIncrement": 1, "defaultVariableChargeUnitSize": 1, "usageRates": [ … ], "timeBandPlans": [ … ], "accessCharges": [ … ], "boltOnCharges": [ … ] } ]
- https://rest.elevatebilling.com/v2/usage-rate-cards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X HEAD \
'https://rest.elevatebilling.com/v2/usage-rate-cards?id=0&contractOwnerId=0&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&availableFrom=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&availableTo=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&rateCardType=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&usageProductId=0&supplierId=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Bodyapplication/jsonrequired
New usage rate card
The billing entity or entities that will have access to this item. This is a multi-select field. If there is only one existing contractOwnerId, you can replace it with another regardless of currency. However, if there are multiple contractOwnerIds, any new or replacement contractOwnerIds must use the same currency as the existing contractOwnerId(s). Different currencies cannot be mixed
Example: [1]
Usage rate card name
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
Default "SELL"
Enum"TEMPLATE""SELL""BUY"
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)
Example: 4
Price rounding style. When pricing usage, each call will be rounded to the specified number of decimal places using the method selected here
Default "MATHEMATICAL"
Enum"UP""DOWN""MATHEMATICAL"
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
Round access charge for first minute. When pricing using access charges round the first minute of the call
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)
Default false
Tax band identifier for bolt on charges (required when bolt on enabled)
Example: 1
Nominal code
Example: "SALES-01QTR2"
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
Default false
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
Example: 1
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
Example: 1
- https://rest.elevatebilling.com/v2/usage-rate-cards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://rest.elevatebilling.com/v2/usage-rate-cards \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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": "SALES-01QTR2",
"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"
}
]
}'OK
The billing entity or entities that will have access to this item. This is a multi-select field. If there is only one existing contractOwnerId, you can replace it with another regardless of currency. However, if there are multiple contractOwnerIds, any new or replacement contractOwnerIds must use the same currency as the existing contractOwnerId(s). Different currencies cannot be mixed
Example: [1]
Usage rate card name
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
Default "SELL"
Enum"TEMPLATE""SELL""BUY"
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)
Example: 4
Price rounding style. When pricing usage, each call will be rounded to the specified number of decimal places using the method selected here
Default "MATHEMATICAL"
Enum"UP""DOWN""MATHEMATICAL"
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
Round access charge for first minute. When pricing using access charges round the first minute of the call
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)
Default false
Tax band identifier for bolt on charges (required when bolt on enabled)
Example: 1
Nominal code
Example: "SALES-01QTR2"
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
Default false
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
Example: 1
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
Example: 1
Response
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": "SALES-01QTR2", "applyCrossTimeBandCharging": false, "defaultQuantityRoundingIncrement": 1, "defaultVariableChargeUnitSize": 1, "usageRates": [ { … } ], "timeBandPlans": [ { … } ], "accessCharges": [ { … } ], "boltOnCharges": [ { … } ] }
- https://rest.elevatebilling.com/v2/usage-rate-cards/{usage_rate_card_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v2/usage-rate-cards/1?fields=id%2Cname' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'summary: true | false'Usage rate card found
The billing entity or entities that will have access to this item. This is a multi-select field. If there is only one existing contractOwnerId, you can replace it with another regardless of currency. However, if there are multiple contractOwnerIds, any new or replacement contractOwnerIds must use the same currency as the existing contractOwnerId(s). Different currencies cannot be mixed
Example: [1]
Usage rate card name
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
Default "SELL"
Enum"TEMPLATE""SELL""BUY"
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)
Example: 4
Price rounding style. When pricing usage, each call will be rounded to the specified number of decimal places using the method selected here
Default "MATHEMATICAL"
Enum"UP""DOWN""MATHEMATICAL"
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
Round access charge for first minute. When pricing using access charges round the first minute of the call
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)
Default false
Tax band identifier for bolt on charges (required when bolt on enabled)
Example: 1
Nominal code
Example: "SALES-01QTR2"
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
Default false
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
Example: 1
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
Example: 1
Response
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": "SALES-01QTR2", "applyCrossTimeBandCharging": false, "defaultQuantityRoundingIncrement": 1, "defaultVariableChargeUnitSize": 1, "usageRates": [ { … } ], "timeBandPlans": [ { … } ], "accessCharges": [ { … } ], "boltOnCharges": [ { … } ] }
- https://rest.elevatebilling.com/v2/usage-rate-cards/{usage_rate_card_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://rest.elevatebilling.com/v2/usage-rate-cards/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Bodyapplication/json-patch+jsonrequiredArray [
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/
The JSON Patch operation to be performed
Enum"add""remove""replace""move""copy""test"
- https://rest.elevatebilling.com/v2/usage-rate-cards/{usage_rate_card_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://rest.elevatebilling.com/v2/usage-rate-cards/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-H 'summary: true | false' \
-d '[
{
"op": "replace",
"path": "/name",
"value": "My Rate Card"
}
]'OK
The billing entity or entities that will have access to this item. This is a multi-select field. If there is only one existing contractOwnerId, you can replace it with another regardless of currency. However, if there are multiple contractOwnerIds, any new or replacement contractOwnerIds must use the same currency as the existing contractOwnerId(s). Different currencies cannot be mixed
Example: [1]
Usage rate card name
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
Default "SELL"
Enum"TEMPLATE""SELL""BUY"
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)
Example: 4
Price rounding style. When pricing usage, each call will be rounded to the specified number of decimal places using the method selected here
Default "MATHEMATICAL"
Enum"UP""DOWN""MATHEMATICAL"
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
Round access charge for first minute. When pricing using access charges round the first minute of the call
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)
Default false
Tax band identifier for bolt on charges (required when bolt on enabled)
Example: 1
Nominal code
Example: "SALES-01QTR2"
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
Default false
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
Example: 1
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
Example: 1
Response
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": "SALES-01QTR2", "applyCrossTimeBandCharging": false, "defaultQuantityRoundingIncrement": 1, "defaultVariableChargeUnitSize": 1, "usageRates": [ { … } ], "timeBandPlans": [ { … } ], "accessCharges": [ { … } ], "boltOnCharges": [ { … } ] }