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

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

Update a rental rate within a rental rate card

Request

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

Rental rate identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed. Note that rental rates can only be updated here. To add a new rate, use /rental-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/rental-rates/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/price",
      "value": 1.03
    }
  ]'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Rental rate identifier

Example: 1
rentalProductIdinteger(int64)required

Rental product identifier

Example: 1
pricenumberrequired

Price

rentalRateTypestring(RentalRateType)

Rental rate type. Required when rentalRatePriceType is RENTAL

Enum"ADVANCE""ARREARS"
rentalRatePriceTypestring(RentalRatePriceType)required

Rental price type - recurring rental or one off?

Enum"RENTAL""ONEOFF"
periodsInAdvancestring(PeriodsInAdvance)

Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE

Enum"STANDARD""ADVANCEDPLUSONEMONTH"
rentalRateFrequencystring(RentalRateFrequency)required

Frequency of rental. Required when rentalRatePriceType is RENTAL

Enum"DAILY""WEEKLY""MONTHLY""YEARLY""QUARTERLY""SIXMONTHS""TWENTYFOURMONTHS"
startDatestring(date)required

Start date

endDatestring(date)

End date

showOnInvoiceboolean

Show on invoice?

Default true
Response
application/json
{
  "id": 1,
  "rentalProductId": 1,
  "price": 0,
  "rentalRateType": "ADVANCE",
  "rentalRatePriceType": "RENTAL",
  "periodsInAdvance": "STANDARD",
  "rentalRateFrequency": "DAILY",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "showOnInvoice": true
}

Delete rental rate

Request

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

Rental rate identifier

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

Responses

OK

Body

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