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

rental-discount-plan-rules

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

Operations

Get a list of rental discount plan rules

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

Filter by rental discount plan

Example: rentalDiscountPlanId=0
productCategoryIdstring(IdFilterParam)

Filter by product category

Example: productCategoryId=0
rentalProductIdstring(IdFilterParam)

Filter by rental product

Example: rentalProductId=0
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/rental-discount-plan-rules?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&rentalDiscountPlanId=0&productCategoryId=0&rentalProductId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Rental discount plan rule identifier

Example: 1
rentalDiscountPlanIdinteger(int64)required

Rental discount plan identifier

Example: 1
productCategoryIdinteger(int64)required

Product category identifier. The rule applies to all rental products in this category (unless rentalProductId is specified)

Example: 1
rentalProductIdinteger(int64)

Rental product identifier. Optional - if specified, the rule applies only to this specific rental product within the category

Example: 1
discountPercentagenumber(double)[ 0 .. 100 ]required

Discount percentage to apply (0-100)

Example: 15
]
Response
application/json
[
  {
    "id": 1,
    "rentalDiscountPlanId": 1,
    "productCategoryId": 1,
    "rentalProductId": 1,
    "discountPercentage": 15
  }
]

Create a new rental discount plan rule

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New rental discount plan rule

rentalDiscountPlanIdinteger(int64)required

Rental discount plan identifier

Example: 1
productCategoryIdinteger(int64)required

Product category identifier. The rule applies to all rental products in this category (unless rentalProductId is specified)

Example: 1
rentalProductIdinteger(int64)

Rental product identifier. Optional - if specified, the rule applies only to this specific rental product within the category

Example: 1
discountPercentagenumber(double)[ 0 .. 100 ]required

Discount percentage to apply (0-100)

Example: 15
curl -i -X POST \
  https://rest.elevatebilling.com/v2/rental-discount-plan-rules \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rentalDiscountPlanId": 1,
    "productCategoryId": 1,
    "rentalProductId": 1,
    "discountPercentage": 15
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Rental discount plan rule identifier

Example: 1
rentalDiscountPlanIdinteger(int64)required

Rental discount plan identifier

Example: 1
productCategoryIdinteger(int64)required

Product category identifier. The rule applies to all rental products in this category (unless rentalProductId is specified)

Example: 1
rentalProductIdinteger(int64)

Rental product identifier. Optional - if specified, the rule applies only to this specific rental product within the category

Example: 1
discountPercentagenumber(double)[ 0 .. 100 ]required

Discount percentage to apply (0-100)

Example: 15
Response
application/json
{
  "id": 1,
  "rentalDiscountPlanId": 1,
  "productCategoryId": 1,
  "rentalProductId": 1,
  "discountPercentage": 15
}

Get a specific rental discount plan rule

Request

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

Rental discount plan rule identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v2/rental-discount-plan-rules/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Rental discount plan rule identifier

Example: 1
rentalDiscountPlanIdinteger(int64)required

Rental discount plan identifier

Example: 1
productCategoryIdinteger(int64)required

Product category identifier. The rule applies to all rental products in this category (unless rentalProductId is specified)

Example: 1
rentalProductIdinteger(int64)

Rental product identifier. Optional - if specified, the rule applies only to this specific rental product within the category

Example: 1
discountPercentagenumber(double)[ 0 .. 100 ]required

Discount percentage to apply (0-100)

Example: 15
Response
application/json
{
  "id": 1,
  "rentalDiscountPlanId": 1,
  "productCategoryId": 1,
  "rentalProductId": 1,
  "discountPercentage": 15
}

Update a rental discount plan rule

Request

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

Rental discount plan rule 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-plan-rules/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/discountPercentage",
      "value": 25
    }
  ]'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Rental discount plan rule identifier

Example: 1
rentalDiscountPlanIdinteger(int64)required

Rental discount plan identifier

Example: 1
productCategoryIdinteger(int64)required

Product category identifier. The rule applies to all rental products in this category (unless rentalProductId is specified)

Example: 1
rentalProductIdinteger(int64)

Rental product identifier. Optional - if specified, the rule applies only to this specific rental product within the category

Example: 1
discountPercentagenumber(double)[ 0 .. 100 ]required

Discount percentage to apply (0-100)

Example: 15
Response
application/json
{
  "id": 1,
  "rentalDiscountPlanId": 1,
  "productCategoryId": 1,
  "rentalProductId": 1,
  "discountPercentage": 15
}

Delete a rental discount plan rule

Request

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

Rental discount plan rule identifier

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

Responses

OK

Body