Skip to content
inclusive-usage-balances/
Provides the remaining in...

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

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

Provides the remaining inclusive usage values — such as duration, data, or one-off events

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

Filter by customer id

Example: customerId=0
siteIdstring(IdFilterParam)

Filter by site id

Example: siteId=0
usageProductInventoryIdstring(IdFilterParam)

Filter by usage product inventory id

Example: usageProductInventoryId=0
billRunIdstring(IdFilterParam)

Filter by bill run id

Example: billRunId=0
assignmentIdstring(IdFilterParam)

Filter by inclusive usage plan assignment id

Example: assignmentId=0
inclusiveUsagePlanIdstring(IdFilterParam)

Filter by inclusive usage plan id

Example: inclusiveUsagePlanId=0
componentIdstring(IdFilterParam)

Filter by inclusive usage component id

Example: componentId=0
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/inclusive-usage-balances?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&customerId=0&siteId=0&usageProductInventoryId=0&billRunId=0&assignmentId=0&inclusiveUsagePlanId=0&componentId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
billRunIdinteger(int64)

bill run identifier

periodStartDatestring(date)

bill run start date

Example: "2025-09-01"
periodEndDatestring(date)

bill run start date

Example: "2025-09-30"
usageProductInventoryIdinteger(int64)

usage product inventory identifier

inclusiveUsageBalanceAssignmentsArray of objects(InclusiveUsageBalanceAssignment)

assignments for this balance

]
Response
application/json
[
  {
    "billRunId": 0,
    "periodStartDate": "2025-09-01",
    "periodEndDate": "2025-09-30",
    "usageProductInventoryId": 0,
    "inclusiveUsageBalanceAssignments": [ … ]
  }
]