Skip to content
/
Create a new usage produc...

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

Get a list of available usage products

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

Filter by product name

Example: name=xyz | in:x,y | like:xyz
usageProductCategoryIdstring(IdFilterParam)

Filter by usage product category

Example: usageProductCategoryId=0
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
nominalCodestring(StringFilterParam)

Filter by nominal code

Example: nominalCode=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/usage-products?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&usageProductCategoryId=0&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&nominalCode=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Usage product identifier

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

Usage product name

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

Nominal code

Example: "SALES-01QTR2"
usageProductCategoryIdinteger(int64)required

Usage product category identifier

Example: 1
directionstring(UsageProductDirection)required

Usage product direction

Enum"INBOUND""OUTBOUND"
performLocalAndNationalCheckboolean

Perform local and national check

Default true
availableFromstring(date)required

Product is available from

availableTostring(date)

Product is available to

productReferenceCanBeRangeboolean

Product reference can be range

Default true
serviceIdRequiredboolean

Service id is required on rental product inventories

Default false
customFieldsArray of objects(CustomField)
productReferenceFormatstringnon-emptyrequired

Regular expression used to validate product references on usage product inventories

Example: "[0-9]{3,11}"
serviceIdFormatstringnon-empty

Regular expression used to validate service ids on usage product inventories

Example: "[a-zA-Z0-9\\-]{3,100}"
]
Response
application/json
[
  {
    "id": 1,
    "name": "string",
    "nominalCode": "SALES-01QTR2",
    "usageProductCategoryId": 1,
    "direction": "INBOUND",
    "performLocalAndNationalCheck": true,
    "availableFrom": "2019-08-24",
    "availableTo": "2019-08-24",
    "productReferenceCanBeRange": true,
    "serviceIdRequired": false,
    "customFields": [ … ],
    "productReferenceFormat": "[0-9]{3,11}",
    "serviceIdFormat": "[a-zA-Z0-9\\-]{3,100}"
  }
]

Create a new usage product

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New usage product

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

Usage product name

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

Nominal code

Example: "SALES-01QTR2"
usageProductCategoryIdinteger(int64)required

Usage product category identifier

Example: 1
directionstring(UsageProductDirection)required

Usage product direction

Enum"INBOUND""OUTBOUND"
performLocalAndNationalCheckboolean

Perform local and national check

Default true
availableFromstring(date)required

Product is available from

availableTostring(date)

Product is available to

productReferenceCanBeRangeboolean

Product reference can be range

Default true
serviceIdRequiredboolean

Service id is required on rental product inventories

Default false
customFieldsArray of objects(CustomField)
productReferenceFormatstringnon-emptyrequired

Regular expression used to validate product references on usage product inventories

Example: "[0-9]{3,11}"
serviceIdFormatstringnon-empty

Regular expression used to validate service ids on usage product inventories

Example: "[a-zA-Z0-9\\-]{3,100}"
curl -i -X POST \
  https://rest.elevatebilling.com/v2/usage-products \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "nominalCode": "SALES-01QTR2",
    "usageProductCategoryId": 1,
    "direction": "INBOUND",
    "performLocalAndNationalCheck": true,
    "availableFrom": "2019-08-24",
    "availableTo": "2019-08-24",
    "productReferenceCanBeRange": true,
    "serviceIdRequired": false,
    "customFields": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "productReferenceFormat": "[0-9]{3,11}",
    "serviceIdFormat": "[a-zA-Z0-9\\-]{3,100}"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Usage product identifier

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

Usage product name

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

Nominal code

Example: "SALES-01QTR2"
usageProductCategoryIdinteger(int64)required

Usage product category identifier

Example: 1
directionstring(UsageProductDirection)required

Usage product direction

Enum"INBOUND""OUTBOUND"
performLocalAndNationalCheckboolean

Perform local and national check

Default true
availableFromstring(date)required

Product is available from

availableTostring(date)

Product is available to

productReferenceCanBeRangeboolean

Product reference can be range

Default true
serviceIdRequiredboolean

Service id is required on rental product inventories

Default false
customFieldsArray of objects(CustomField)
productReferenceFormatstringnon-emptyrequired

Regular expression used to validate product references on usage product inventories

Example: "[0-9]{3,11}"
serviceIdFormatstringnon-empty

Regular expression used to validate service ids on usage product inventories

Example: "[a-zA-Z0-9\\-]{3,100}"
Response
application/json
{
  "id": 1,
  "name": "string",
  "nominalCode": "SALES-01QTR2",
  "usageProductCategoryId": 1,
  "direction": "INBOUND",
  "performLocalAndNationalCheck": true,
  "availableFrom": "2019-08-24",
  "availableTo": "2019-08-24",
  "productReferenceCanBeRange": true,
  "serviceIdRequired": false,
  "customFields": [
    { … }
  ],
  "productReferenceFormat": "[0-9]{3,11}",
  "serviceIdFormat": "[a-zA-Z0-9\\-]{3,100}"
}

Check if usage product exists

Request

Security
bearerAuth
Query
namestring(StringFilterParam)

Filter by product name

Example: name=xyz | in:x,y | like:xyz
usageProductCategoryIdstring(IdFilterParam)

Filter by usage product category

Example: usageProductCategoryId=0
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
nominalCodestring(StringFilterParam)

Filter by nominal code

Example: nominalCode=xyz | in:x,y | like:xyz
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v2/usage-products?name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&usageProductCategoryId=0&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&nominalCode=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Body

Get a specific usage product

Request

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

Usage product identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v2/usage-products/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Usage product found

Bodyapplication/json
idinteger(int64)read-only

Usage product identifier

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

Usage product name

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

Nominal code

Example: "SALES-01QTR2"
usageProductCategoryIdinteger(int64)required

Usage product category identifier

Example: 1
directionstring(UsageProductDirection)required

Usage product direction

Enum"INBOUND""OUTBOUND"
performLocalAndNationalCheckboolean

Perform local and national check

Default true
availableFromstring(date)required

Product is available from

availableTostring(date)

Product is available to

productReferenceCanBeRangeboolean

Product reference can be range

Default true
serviceIdRequiredboolean

Service id is required on rental product inventories

Default false
customFieldsArray of objects(CustomField)
productReferenceFormatstringnon-emptyrequired

Regular expression used to validate product references on usage product inventories

Example: "[0-9]{3,11}"
serviceIdFormatstringnon-empty

Regular expression used to validate service ids on usage product inventories

Example: "[a-zA-Z0-9\\-]{3,100}"
Response
application/json
{
  "id": 1,
  "name": "string",
  "nominalCode": "SALES-01QTR2",
  "usageProductCategoryId": 1,
  "direction": "INBOUND",
  "performLocalAndNationalCheck": true,
  "availableFrom": "2019-08-24",
  "availableTo": "2019-08-24",
  "productReferenceCanBeRange": true,
  "serviceIdRequired": false,
  "customFields": [
    { … }
  ],
  "productReferenceFormat": "[0-9]{3,11}",
  "serviceIdFormat": "[a-zA-Z0-9\\-]{3,100}"
}

Update a usage product

Request

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

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

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Usage product identifier

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

Usage product name

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

Nominal code

Example: "SALES-01QTR2"
usageProductCategoryIdinteger(int64)required

Usage product category identifier

Example: 1
directionstring(UsageProductDirection)required

Usage product direction

Enum"INBOUND""OUTBOUND"
performLocalAndNationalCheckboolean

Perform local and national check

Default true
availableFromstring(date)required

Product is available from

availableTostring(date)

Product is available to

productReferenceCanBeRangeboolean

Product reference can be range

Default true
serviceIdRequiredboolean

Service id is required on rental product inventories

Default false
customFieldsArray of objects(CustomField)
productReferenceFormatstringnon-emptyrequired

Regular expression used to validate product references on usage product inventories

Example: "[0-9]{3,11}"
serviceIdFormatstringnon-empty

Regular expression used to validate service ids on usage product inventories

Example: "[a-zA-Z0-9\\-]{3,100}"
Response
application/json
{
  "id": 1,
  "name": "string",
  "nominalCode": "SALES-01QTR2",
  "usageProductCategoryId": 1,
  "direction": "INBOUND",
  "performLocalAndNationalCheck": true,
  "availableFrom": "2019-08-24",
  "availableTo": "2019-08-24",
  "productReferenceCanBeRange": true,
  "serviceIdRequired": false,
  "customFields": [
    { … }
  ],
  "productReferenceFormat": "[0-9]{3,11}",
  "serviceIdFormat": "[a-zA-Z0-9\\-]{3,100}"
}

Get a list of available usage product categories

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

Filter by name

Example: name=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/usage-product-categories?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Usage product category identifier

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

Usage product category name

]
Response
application/json
[
  {
    "id": 1,
    "name": "string"
  }
]

Returns a list of available suppliers

Request

Returns a list of available suppliers and corresponding data sources for usage products

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

Filter by id

Example: id=0
usageProductIdstring(IdFilterParam)

Filter by usage product id

Example: usageProductId=0
supplierIdstring(IdFilterParam)

Filter by supplier id

Example: supplierId=0
supplierAccountIdstring(IdFilterParam)

Filter by supplier account id

Example: supplierAccountId=0
primaryReferenceDataSourceIdstring(IdFilterParam)

Filter by primary reference data source id

Example: primaryReferenceDataSourceId=0
secondaryReferenceDataSourceIdstring(IdFilterParam)

Filter by secondary reference data source id

Example: secondaryReferenceDataSourceId=0
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/usage-product-suppliers?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&id=0&usageProductId=0&supplierId=0&supplierAccountId=0&primaryReferenceDataSourceId=0&secondaryReferenceDataSourceId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-onlyrequired

usage product supplier identifier

Example: 1
usageProductIdinteger(int64)read-onlyrequired

usage product identifier

Example: 1
supplierIdinteger(int64)read-onlyrequired

supplier identifier

Example: 1
supplierAccountIdinteger(int64)read-onlyrequired

supplier account identifier

Example: 1
primaryReferenceDataSourceIdinteger(int64)read-onlyrequired

primary reference data source identifier

Example: 1
secondaryReferenceDataSourceIdinteger(int64)read-onlyrequired

secondary reference data source identifier

Example: 1
]
Response
application/json
[
  {
    "id": 1,
    "usageProductId": 1,
    "supplierId": 1,
    "supplierAccountId": 1,
    "primaryReferenceDataSourceId": 1,
    "secondaryReferenceDataSourceId": 1
  }
]

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

rental-product-category

Rental product categories are used to group rental products together

Operations