Skip to content
/
Create a new rental disco...

Elevate Pricing API (2.22)

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

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

rental-discount-plans

Rental discount plans provide percentage-based discounts on rental products for Customers

Operations

Get a list of available rental discount plans

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
contractOwnerIdstring(IdFilterParam)

Filter by contract owner

Example: contractOwnerId=0
namestring(StringFilterParam)

Filter by name

Example: name=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/rental-discount-plans?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' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Rental discount plan identifier

Example: 1
contractOwnerIdinteger(int32)required

The billing entity that will have access to this item

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

Rental discount plan name. Must be unique for a given contract owner

Example: "12 month 50% off"
durationInMonthsinteger(int32)[ 1 .. 120 ]required

Duration of the discount plan in months

Example: 12
availableFromstring(date)required

Available from date

availableTostring(date)

Available to date

]
Response
application/json
[
  {
    "id": 1,
    "contractOwnerId": 1,
    "name": "12 month 50% off",
    "durationInMonths": 12,
    "availableFrom": "2019-08-24",
    "availableTo": "2019-08-24"
  }
]

Check if a rental discount plan exists

Request

Security
bearerAuth
Query
idstring(IdFilterParam)

Filter by id

Example: id=0
contractOwnerIdstring(IdFilterParam)

Filter by contract owner

Example: contractOwnerId=0
namestring(StringFilterParam)

Filter by name

Example: name=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 HEAD \
  'https://rest.elevatebilling.com/v2/rental-discount-plans?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' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body

Create a new rental discount plan

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New rental discount plan

contractOwnerIdinteger(int32)required

The billing entity that will have access to this item

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

Rental discount plan name. Must be unique for a given contract owner

Example: "12 month 50% off"
durationInMonthsinteger(int32)[ 1 .. 120 ]required

Duration of the discount plan in months

Example: 12
availableFromstring(date)required

Available from date

availableTostring(date)

Available to date

curl -i -X POST \
  https://rest.elevatebilling.com/v2/rental-discount-plans \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contractOwnerId": 1,
    "name": "12 month 50% off",
    "durationInMonths": 12,
    "availableFrom": "2019-08-24",
    "availableTo": "2019-08-24"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Rental discount plan identifier

Example: 1
contractOwnerIdinteger(int32)required

The billing entity that will have access to this item

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

Rental discount plan name. Must be unique for a given contract owner

Example: "12 month 50% off"
durationInMonthsinteger(int32)[ 1 .. 120 ]required

Duration of the discount plan in months

Example: 12
availableFromstring(date)required

Available from date

availableTostring(date)

Available to date

Response
application/json
{
  "id": 1,
  "contractOwnerId": 1,
  "name": "12 month 50% off",
  "durationInMonths": 12,
  "availableFrom": "2019-08-24",
  "availableTo": "2019-08-24"
}

Get a specific rental discount plan

Request

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

Rental discount plan identifier

Example: 1
Query
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required (other fields will be returned as null for now)

Example: fields=id,name
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/rental-discount-plans/1?fields=id%2Cname' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Rental discount plan found

Bodyapplication/json
idinteger(int64)read-only

Rental discount plan identifier

Example: 1
contractOwnerIdinteger(int32)required

The billing entity that will have access to this item

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

Rental discount plan name. Must be unique for a given contract owner

Example: "12 month 50% off"
durationInMonthsinteger(int32)[ 1 .. 120 ]required

Duration of the discount plan in months

Example: 12
availableFromstring(date)required

Available from date

availableTostring(date)

Available to date

Response
application/json
{
  "id": 1,
  "contractOwnerId": 1,
  "name": "12 month 50% off",
  "durationInMonths": 12,
  "availableFrom": "2019-08-24",
  "availableTo": "2019-08-24"
}

Update a rental discount plan

Request

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

Rental discount plan identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

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-discount-plans/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/name",
      "value": "My Discount Plan"
    }
  ]'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Rental discount plan identifier

Example: 1
contractOwnerIdinteger(int32)required

The billing entity that will have access to this item

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

Rental discount plan name. Must be unique for a given contract owner

Example: "12 month 50% off"
durationInMonthsinteger(int32)[ 1 .. 120 ]required

Duration of the discount plan in months

Example: 12
availableFromstring(date)required

Available from date

availableTostring(date)

Available to date

Response
application/json
{
  "id": 1,
  "contractOwnerId": 1,
  "name": "12 month 50% off",
  "durationInMonths": 12,
  "availableFrom": "2019-08-24",
  "availableTo": "2019-08-24"
}

rental-discount-plan-rules

Rental discount plan rules define the discount percentage for specific rental product categories

Operations