Skip to content
/
Check if usage rate overr...

Elevate Pricing Assignment API (1.15)

Customer and Site Pricing Assignment

Provides read & write access to customer, site and inventory level pricing assignments including price overrides

Rental and Usage Rate Cards

Rental and Usage rate cards can be assigned at Customer, Site or Usage Inventory level

  • Rate cards at Customer level will apply to all sites and product inventories under the customer
  • Rate cards at Site level will override any rate card assigned at Customer level - the product inventories within this Site will use the assigned rate card
  • Rate cards at Inventory level override any rate card assigned at Customer or Site level; the individual product inventory will use the assigned rate card

Inclusive Usage Plans

Inclusive Usage plans can be assigned at Customer, Site or Usage Product Inventory level

  • Plans at Customer level will be shared between Sites for that Customer - e.g. 1000 minutes would be shared between the Sites
  • Plans can be added at Site level to just apply to that Site - this is in addition to any shared plan set at Customer level
  • Plans can be added at UPI level to just apply to that inventory item - this is in addition to any shared plan(s) set at Customer or Site level

Rental and Usage Rate Overrides

Rate overrides are the last pricing assignment level - they will override any rates that are set on the Rental or Usage rate card that is assigned Some examples;

  • A Usage rate override is set against a Customer - Sites belonging to this Customer will inherit the override regardless of the Usage rate card assigned
  • A Rental rate card is assigned at Site level and a Rental Rate Override is set for a product - the override price will overrule the price in the rate card for that product
Download OpenAPI description
billing-rest-assignment.json
billing-rest-assignment.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

usage-rate-card-assignments

Usage rate cards contain the usage pricing structure - they can be assigned at Customer, Site or Usage Product Inventory level (UPI)

Operations

rental-rate-card-assignments

Rental rate cards contain the rental pricing structure - they can be assigned at Customer, Site or Rental Product Inventory level (RPI)

Operations

inclusive-usage-plan-assignments

Inclusive usage plans are an inclusive bundle assigned at Customer, Site or Usage Inventory level

Operations

usage-rate-overrides

Usage rate overrides can be set at Customer, Site or Usage Inventory level to override the pricing in the rate card

Operations

Get a list of usage overrides

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

Filter by assignment level - CUSTOMER, SITE or INVENTORY

Example: assignmentLevel=xyz | in:x,y | like:xyz
customerIdstring(IdFilterParam)

Filter by customer

Example: customerId=0
siteIdstring(IdFilterParam)

Filter by site

Example: siteId=0
usageProductInventoryIdstring(IdFilterParam)

Filter by usage product inventory

Example: usageProductInventoryId=0
usageProductIdstring(IdFilterParam)

Filter by usage product

Example: usageProductId=0
startDatestring(DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDatestring(DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/usage-rate-overrides?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&assignmentLevel=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerId=0&siteId=0&usageProductInventoryId=0&usageProductId=0&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=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

Usage rate override identifier

Example: 1
assignmentLevelstringrequired

Rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required.

Example: "CUSTOMER"
Discriminator
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
supplierIdinteger(int64)

Supplier identifier

Example: 1
chargeGroupIdinteger(int64)required

Charge group identifier

Example: 1
variableChargeUnitSizeinteger(int32)>= 1required

Variable charge unit size

Example: 60
quantityRoundingIncrementnumber>= 1required

Quantity rounding increment

Example: 1
startDatestring(date)required

Start date

appliesToISDNOnlyboolean

Applies to ISDN calls only?

Default false
endDatestring(date)

End date

peakValuenumber

Peak value

offPeakValuenumber

Off peak value

weekendValuenumber

Weekend value

peakMinimumChargenumberrequired

Peak minimum charge

offPeakMinimumChargenumberrequired

Off peak minimum charge

weekendMinimumChargenumberrequired

Weekend minimum charge

peakInitialChargenumberrequired

Peak initial charge

offPeakInitialChargenumberrequired

Off peak initial charge

weekendInitialChargenumberrequired

Weekend initial charge

peakInitialChargePeriodinteger(int32)required

Peak initial charge period

offPeakInitialChargePeriodinteger(int32)required

Off peak initial charge period

weekendInitialChargePeriodinteger(int32)required

Weekend initial charge period

customerIdinteger(int64)required

Customer identifier

Example: 1
applyThisToChildrenbooleanrequired

Apply this override to children?

Default true
]
Response
application/json
[
  {
    "id": 1,
    "assignmentLevel": "CUSTOMER",
    "usageProductId": 1,
    "supplierId": 1,
    "chargeGroupId": 1,
    "variableChargeUnitSize": 60,
    "quantityRoundingIncrement": 1,
    "startDate": "2019-08-24",
    "appliesToISDNOnly": false,
    "endDate": "2019-08-24",
    "peakValue": 0,
    "offPeakValue": 0,
    "weekendValue": 0,
    "peakMinimumCharge": 0,
    "offPeakMinimumCharge": 0,
    "weekendMinimumCharge": 0,
    "peakInitialCharge": 0,
    "offPeakInitialCharge": 0,
    "weekendInitialCharge": 0,
    "peakInitialChargePeriod": 0,
    "offPeakInitialChargePeriod": 0,
    "weekendInitialChargePeriod": 0
  }
]

Create a new usage rate override

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New usage rate override

assignmentLevelstringrequired

Rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required.

Example: "CUSTOMER"
Discriminator
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
supplierIdinteger(int64)

Supplier identifier

Example: 1
chargeGroupIdinteger(int64)required

Charge group identifier

Example: 1
variableChargeUnitSizeinteger(int32)>= 1required

Variable charge unit size

Example: 60
quantityRoundingIncrementnumber>= 1required

Quantity rounding increment

Example: 1
startDatestring(date)required

Start date

appliesToISDNOnlyboolean

Applies to ISDN calls only?

Default false
endDatestring(date)

End date

peakValuenumber

Peak value

offPeakValuenumber

Off peak value

weekendValuenumber

Weekend value

peakMinimumChargenumberrequired

Peak minimum charge

offPeakMinimumChargenumberrequired

Off peak minimum charge

weekendMinimumChargenumberrequired

Weekend minimum charge

peakInitialChargenumberrequired

Peak initial charge

offPeakInitialChargenumberrequired

Off peak initial charge

weekendInitialChargenumberrequired

Weekend initial charge

peakInitialChargePeriodinteger(int32)required

Peak initial charge period

offPeakInitialChargePeriodinteger(int32)required

Off peak initial charge period

weekendInitialChargePeriodinteger(int32)required

Weekend initial charge period

customerIdinteger(int64)required

Customer identifier

Example: 1
applyThisToChildrenbooleanrequired

Apply this override to children?

Default true
curl -i -X POST \
  https://rest.elevatebilling.com/v1/usage-rate-overrides \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assignmentLevel": "CUSTOMER",
    "usageProductId": 1,
    "supplierId": 1,
    "chargeGroupId": 1,
    "variableChargeUnitSize": 60,
    "quantityRoundingIncrement": 1,
    "startDate": "2019-08-24",
    "appliesToISDNOnly": false,
    "endDate": "2019-08-24",
    "peakValue": 0,
    "offPeakValue": 0,
    "weekendValue": 0,
    "peakMinimumCharge": 0,
    "offPeakMinimumCharge": 0,
    "weekendMinimumCharge": 0,
    "peakInitialCharge": 0,
    "offPeakInitialCharge": 0,
    "weekendInitialCharge": 0,
    "peakInitialChargePeriod": 0,
    "offPeakInitialChargePeriod": 0,
    "weekendInitialChargePeriod": 0,
    "customerId": 1,
    "applyThisToChildren": true
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Usage rate override identifier

Example: 1
assignmentLevelstringrequired

Rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required.

Example: "CUSTOMER"
Discriminator
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
supplierIdinteger(int64)

Supplier identifier

Example: 1
chargeGroupIdinteger(int64)required

Charge group identifier

Example: 1
variableChargeUnitSizeinteger(int32)>= 1required

Variable charge unit size

Example: 60
quantityRoundingIncrementnumber>= 1required

Quantity rounding increment

Example: 1
startDatestring(date)required

Start date

appliesToISDNOnlyboolean

Applies to ISDN calls only?

Default false
endDatestring(date)

End date

peakValuenumber

Peak value

offPeakValuenumber

Off peak value

weekendValuenumber

Weekend value

peakMinimumChargenumberrequired

Peak minimum charge

offPeakMinimumChargenumberrequired

Off peak minimum charge

weekendMinimumChargenumberrequired

Weekend minimum charge

peakInitialChargenumberrequired

Peak initial charge

offPeakInitialChargenumberrequired

Off peak initial charge

weekendInitialChargenumberrequired

Weekend initial charge

peakInitialChargePeriodinteger(int32)required

Peak initial charge period

offPeakInitialChargePeriodinteger(int32)required

Off peak initial charge period

weekendInitialChargePeriodinteger(int32)required

Weekend initial charge period

customerIdinteger(int64)required

Customer identifier

Example: 1
applyThisToChildrenbooleanrequired

Apply this override to children?

Default true
Response
application/json
{
  "id": 1,
  "assignmentLevel": "CUSTOMER",
  "usageProductId": 1,
  "supplierId": 1,
  "chargeGroupId": 1,
  "variableChargeUnitSize": 60,
  "quantityRoundingIncrement": 1,
  "startDate": "2019-08-24",
  "appliesToISDNOnly": false,
  "endDate": "2019-08-24",
  "peakValue": 0,
  "offPeakValue": 0,
  "weekendValue": 0,
  "peakMinimumCharge": 0,
  "offPeakMinimumCharge": 0,
  "weekendMinimumCharge": 0,
  "peakInitialCharge": 0,
  "offPeakInitialCharge": 0,
  "weekendInitialCharge": 0,
  "peakInitialChargePeriod": 0,
  "offPeakInitialChargePeriod": 0,
  "weekendInitialChargePeriod": 0,
  "customerId": 1,
  "applyThisToChildren": true
}

Check if usage rate override exists

Request

Security
bearerAuth
Query
assignmentLevelstring(StringFilterParam)

Filter by assignment level - CUSTOMER, SITE or INVENTORY

Example: assignmentLevel=xyz | in:x,y | like:xyz
customerIdstring(IdFilterParam)

Filter by customer

Example: customerId=0
siteIdstring(IdFilterParam)

Filter by site

Example: siteId=0
usageProductInventoryIdstring(IdFilterParam)

Filter by usage product inventory

Example: usageProductInventoryId=0
usageProductIdstring(IdFilterParam)

Filter by usage product

Example: usageProductId=0
startDatestring(DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDatestring(DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v1/usage-rate-overrides?assignmentLevel=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerId=0&siteId=0&usageProductInventoryId=0&usageProductId=0&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=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

Exists

Body

Update a usage rate override

Request

Security
bearerAuth
Path
assignmentLevelstringrequired

Assignment level to be updated - CUSTOMER, SITE or INVENTORY

Enum"CUSTOMER""SITE""INVENTORY"
usage_rate_override_idinteger(int64)(IdParam)>= 1required

Usage rate override 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/v1/usage-rate-overrides/{assignmentLevel}/1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/endDate",
      "value": "2049-07-15"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Usage rate override identifier

Example: 1
assignmentLevelstringrequired

Rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required.

Example: "CUSTOMER"
Discriminator
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
supplierIdinteger(int64)

Supplier identifier

Example: 1
chargeGroupIdinteger(int64)required

Charge group identifier

Example: 1
variableChargeUnitSizeinteger(int32)>= 1required

Variable charge unit size

Example: 60
quantityRoundingIncrementnumber>= 1required

Quantity rounding increment

Example: 1
startDatestring(date)required

Start date

appliesToISDNOnlyboolean

Applies to ISDN calls only?

Default false
endDatestring(date)

End date

peakValuenumber

Peak value

offPeakValuenumber

Off peak value

weekendValuenumber

Weekend value

peakMinimumChargenumberrequired

Peak minimum charge

offPeakMinimumChargenumberrequired

Off peak minimum charge

weekendMinimumChargenumberrequired

Weekend minimum charge

peakInitialChargenumberrequired

Peak initial charge

offPeakInitialChargenumberrequired

Off peak initial charge

weekendInitialChargenumberrequired

Weekend initial charge

peakInitialChargePeriodinteger(int32)required

Peak initial charge period

offPeakInitialChargePeriodinteger(int32)required

Off peak initial charge period

weekendInitialChargePeriodinteger(int32)required

Weekend initial charge period

customerIdinteger(int64)required

Customer identifier

Example: 1
applyThisToChildrenbooleanrequired

Apply this override to children?

Default true
Response
application/json
{
  "id": 1,
  "assignmentLevel": "CUSTOMER",
  "usageProductId": 1,
  "supplierId": 1,
  "chargeGroupId": 1,
  "variableChargeUnitSize": 60,
  "quantityRoundingIncrement": 1,
  "startDate": "2019-08-24",
  "appliesToISDNOnly": false,
  "endDate": "2019-08-24",
  "peakValue": 0,
  "offPeakValue": 0,
  "weekendValue": 0,
  "peakMinimumCharge": 0,
  "offPeakMinimumCharge": 0,
  "weekendMinimumCharge": 0,
  "peakInitialCharge": 0,
  "offPeakInitialCharge": 0,
  "weekendInitialCharge": 0,
  "peakInitialChargePeriod": 0,
  "offPeakInitialChargePeriod": 0,
  "weekendInitialChargePeriod": 0,
  "customerId": 1,
  "applyThisToChildren": true
}

Delete a usage rate override

Request

Can only be done if not included in a finalised bill run

Security
bearerAuth
Path
assignmentLevelstringrequired

Assignment level to be deleted - CUSTOMER, SITE or INVENTORY

Enum"CUSTOMER""SITE""INVENTORY"
usage_rate_override_idinteger(int64)(IdParam)>= 1required

Usage rate override identifier

Example: 1
curl -i -X DELETE \
  'https://rest.elevatebilling.com/v1/usage-rate-overrides/{assignmentLevel}/1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body

rental-rate-overrides

Rental rate overrides can be set at Customer, Site or Rental Inventory level to override the pricing in the rate card

Operations

buy-rental-rate-overrides

Buy rental rate overrides can be set at Inventory level to override the pricing in the buy rate card

Operations