Skip to content
custom-fields/
Get a list of available c...

Elevate Products API (2.13)

Product Management

Provides read & write access to usage and rental product entities

Definitions

  • Rental Product - a product or service that is billed on a fixed charge; for example, a broadband service, connection or site visit
  • Usage Product - a product that is billed based on it's usage, such as calls or data; these typically fall into one of the following categories within Elevate; outbound such as CPS/IDA, Mobile or VoIP; and Inbound
Download OpenAPI description
billing-rest-product.json
billing-rest-product.yaml
Languages
Servers
https://rest.elevatebilling.com/v2

usage-products

Usage products represent products that are billed based on usage

Operations

rental-products

Rental products represent a product or service that is billed on a fixed charge

Operations

custom-fields

Custom fields can be added to usage or rental products or to rental product inventory lines

Operations

Get a list of available custom fields

Request

Get a list of available custom fields for usage, rental products and rental product inventories

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
labelstring(StringFilterParam)

Filter by label

Example: label=xyz | in:x,y | like:xyz
productCategoryIdstring(IdFilterParam)

Filter by product category id

Example: productCategoryId=0
entityLevelstring(CustomFieldEntityLevel)

Filter by this entity level only

Enum"USAGE_PRODUCT""RENTAL_PRODUCT""RENTAL_PRODUCT_INVENTORY""SITE""CUSTOMER"
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/product-custom-fields?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&label=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&productCategoryId=0&entityLevel=USAGE_PRODUCT' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Custom field identifier

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

Label for the custom field

productCategoryIdsArray of integers(int64)required

Product categories that this custom field applies to

entityLevelstring(CustomFieldEntityLevel)required

Indicates the entity level the custom field applies to

Enum"USAGE_PRODUCT""RENTAL_PRODUCT""RENTAL_PRODUCT_INVENTORY""SITE""CUSTOMER"
]
Response
application/json
[
  {
    "id": 1,
    "label": "string",
    "productCategoryIds": [ … ],
    "entityLevel": "USAGE_PRODUCT"
  }
]

rental-product-category

Rental product categories are used to group rental products together

Operations