Skip to content

Elevate Pricing API (2.21)

Usage and Rental Pricing Management

Provides read & write access to usage and rental rate cards and inclusive usage plans

Definitions

  • 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
billing-rest-pricing.json
billing-rest-pricing.yaml
Languages
Servers
https://rest.elevatebilling.com/v2

usage-rate-cards

Usage rate cards represent the pricing structure for usage products that can be sold to Customers

Operations

usage-rates

Usage rates represent the pricing rates for a usage product

Operations

Get a list of usage rates

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
usageRateCardIdstring(IdFilterParam)required

Filter by usage rate card

Example: usageRateCardId=0
chargeGroupIdstring(IdFilterParam)

Filter by charge group

Example: chargeGroupId=0
usageRateTypestring(StringFilterParam)

Filter by usage rate type

Example: usageRateType=xyz | in:x,y | like:xyz
availableFromstring(DateFilterParam)

Filter by available from date

Example: availableFrom=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
availableTostring(DateFilterParam)

Filter by available to date

Example: availableTo=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/usage-rates?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&usageRateCardId=0&chargeGroupId=0&usageRateType=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' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Usage rate identifier

Example: 1
chargeGroupIdinteger(int64)required

Charge group identifier

Example: 1
usageRateTypestring(UsageRateType)required

Usage rate type

Enum"MARKUP""VARIABLE"
peakInitialChargenumber

Peak initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

peakInitialPeriodinteger(int32)required

Peak initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

peakValuenumberrequired

Peak value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

peakMinimumnumberrequired

Peak minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

offPeakInitialChargenumber

Offpeak initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

offPeakInitialPeriodinteger(int32)required

Offpeak initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

offPeakValuenumberrequired

Offpeak value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

offPeakMinimumnumberrequired

Offpeak minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

weekendInitialChargenumber

Weekend initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

weekendInitialPeriodinteger(int32)required

Weekend initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

weekendValuenumberrequired

Weekend value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

weekendMinimumnumberrequired

Weekend minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

quantityRoundingIncrementnumberrequired

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
variableChargeUnitSizeinteger(int32)

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 (or the minor currency unit) per minute; if this value is 1024 MB then the charge is pence per gigabyte. The default value can be overridden at Charge Group level

Example: 1
surchargeInitialChargenumber

Surcharge initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

surchargeInitialPeriodinteger(int32)

Surcharge initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the surchargeInitialCharge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the surchargeInitialCharge). Any remaining period will be charged at the assigned variable charge (the surchargeValue)

surchargeValuenumber

Surcharge value per min. A value of zero will ignore surcharging. If the UPI has applySurcharges and this rate matches then an extra surcharge will be applied as, surchargeValue x the quantity (in mins). The value is pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up

surchargeMinimumnumber

Surcharge minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

startDatestring(date)required

Start date

endDatestring(date)

End date

]
Response
application/json
[
  {
    "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"
  }
]

Update a usage rate within a usage rate card

Request

Security
bearerAuth
Path
usage_rate_idinteger(int64)(IdParam)>= 1required

Usage rate identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed. Note that usage rates can only be updated here. To add a new rate, use /usage-rate-cards/ PATCH method

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
curl -i -X PATCH \
  https://rest.elevatebilling.com/v2/usage-rates/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/offPeakValue",
      "value": "5"
    }
  ]'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Usage rate identifier

Example: 1
chargeGroupIdinteger(int64)required

Charge group identifier

Example: 1
usageRateTypestring(UsageRateType)required

Usage rate type

Enum"MARKUP""VARIABLE"
peakInitialChargenumber

Peak initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

peakInitialPeriodinteger(int32)required

Peak initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

peakValuenumberrequired

Peak value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

peakMinimumnumberrequired

Peak minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

offPeakInitialChargenumber

Offpeak initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

offPeakInitialPeriodinteger(int32)required

Offpeak initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

offPeakValuenumberrequired

Offpeak value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

offPeakMinimumnumberrequired

Offpeak minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

weekendInitialChargenumber

Weekend initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

weekendInitialPeriodinteger(int32)required

Weekend initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the Initial Charge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the Initial Charge). Any remaining period will be charged at the assigned variable charge

weekendValuenumberrequired

Weekend value. The pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up. For example 3 pence per minute or 35%

weekendMinimumnumberrequired

Weekend minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

quantityRoundingIncrementnumberrequired

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
variableChargeUnitSizeinteger(int32)

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 (or the minor currency unit) per minute; if this value is 1024 MB then the charge is pence per gigabyte. The default value can be overridden at Charge Group level

Example: 1
surchargeInitialChargenumber

Surcharge initial charge. The charge that would be applied to the Initial Period. For example, if Initial Period is set to 30 seconds the first 30 seconds of the call would be charged at 50 pence (or the minor currency unit) if this value was set to 50 pence. Similarly, if Initial Period is set to 512 MB the first 512 MB of data would be charged at 100 pence if this value was set to 100 pence

surchargeInitialPeriodinteger(int32)

Surcharge initial period. This specifies the duration of an initial period if one is required. For example, if this value is 30 seconds then the first 30 seconds of the call would be charged at a fixed rate (the surchargeInitialCharge). Similarly, if this value is 1024 MB then the first 1024 MB of data would be charged at a fixed rate (the surchargeInitialCharge). Any remaining period will be charged at the assigned variable charge (the surchargeValue)

surchargeValuenumber

Surcharge value per min. A value of zero will ignore surcharging. If the UPI has applySurcharges and this rate matches then an extra surcharge will be applied as, surchargeValue x the quantity (in mins). The value is pence (or the minor currency unit) per unit if Charge Type is Variable and a percentage if the Charge Type is Mark Up

surchargeMinimumnumber

Surcharge minimum charge. The minimum charge that will be applied. For example, a call calculated to be 4.3 pence (or the minor currency unit) would be charged at 5 pence if this value was set to 5 pence

startDatestring(date)required

Start date

endDatestring(date)

End date

Response
application/json
{
  "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"
}

Delete usage rate

Request

Security
bearerAuth
Path
usage_rate_idinteger(int64)(IdParam)>= 1required

Usage rate identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v2/usage-rates/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body

rental-rate-cards

Rental rates card represent the pricing structure for rental products that can be sold to Customers

Operations

rental-rates

Rental rates represent the pricing rates for a rental product

Operations

inclusive-usage-plans

Inclusive usage plans represent an inclusive bundle that can be sold to Customers

Operations

inclusive-usage-balances

Inclusive usage balances represent the current balance of an inclusive usage plan for a Customer, Site or Inventory

Operations