# Elevate Pricing API

### 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


Version: 2.21

## Servers

```
https://rest.elevatebilling.com/v2
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Elevate Pricing API](https://docs.elevatebilling.com/_bundle/openapi/prod/gen/billing-rest-pricing.yaml)

## usage-rate-cards

Usage rate cards represent the pricing structure for usage products that can be sold to Customers

### Get a list of available usage rate cards

 - [GET /usage-rate-cards](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rate-cards/getusageratecards.md)

### Check if a usage rate card exists

 - [HEAD /usage-rate-cards](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rate-cards/checkusageratecards.md)

### Create a new usage rate card

 - [POST /usage-rate-cards](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rate-cards/createusageratecard.md)

### Get a specific usage rate card

 - [GET /usage-rate-cards/{usage_rate_card_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rate-cards/getusageratecard.md)

### Delete a specific usage rate card

 - [DELETE /usage-rate-cards/{usage_rate_card_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rate-cards/deleteusageratecard.md)

### Update a usage rate card

 - [PATCH /usage-rate-cards/{usage_rate_card_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rate-cards/updateusageratecard.md)

## usage-rates

Usage rates represent the pricing rates for a usage product

### Get a list of usage rates

 - [GET /usage-rates](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rates/getusagerates.md)

### Update a usage rate within a usage rate card

 - [PATCH /usage-rates/{usage_rate_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rates/updateusagerate.md)

### Delete usage rate

 - [DELETE /usage-rates/{usage_rate_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/usage-rates/deleteusagerate.md)

## rental-rate-cards

Rental rates card represent the pricing structure for rental products that can be sold to Customers

### Get a list of available rental rate cards

 - [GET /rental-rate-cards](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/rental-rate-cards/getrentalratecards.md)

### Check if a rental rate card exists

 - [HEAD /rental-rate-cards](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/rental-rate-cards/checkrentalratecards.md)

### Create a new rental rate card

 - [POST /rental-rate-cards](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/rental-rate-cards/createrentalratecard.md)

### Get a specific rental rate card

 - [GET /rental-rate-cards/{rental_rate_card_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/rental-rate-cards/getrentalratecard.md)

### Update a rental rate card

 - [PATCH /rental-rate-cards/{rental_rate_card_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/rental-rate-cards/updaterentalratecard.md)

## rental-rates

Rental rates represent the pricing rates for a rental product

### Update a rental rate within a rental rate card

 - [PATCH /rental-rates/{rental_rate_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/rental-rates/updaterentalrate.md)

### Delete rental rate

 - [DELETE /rental-rates/{rental_rate_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/rental-rates/deleterentalrate.md)

## inclusive-usage-plans

Inclusive usage plans represent an inclusive bundle that can be sold to Customers

### Get a list of available inclusive usage plans

 - [GET /inclusive-usage-plans](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/inclusive-usage-plans/getinclusiveusageplans.md)

### Check if an inclusive usage plan exists

 - [HEAD /inclusive-usage-plans](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/inclusive-usage-plans/checkinclusiveusageplans.md)

### Create a new inclusive usage plan

 - [POST /inclusive-usage-plans](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/inclusive-usage-plans/createinclusiveusageplan.md)

### Get a specific inclusive usage plan

 - [GET /inclusive-usage-plans/{inclusive_usage_plan_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/inclusive-usage-plans/getinclusiveusageplan.md)

### Patch update inclusive usage plan

 - [PATCH /inclusive-usage-plans/{inclusive_usage_plan_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/inclusive-usage-plans/updateinclusiveusageplan.md)

## inclusive-usage-balances

Inclusive usage balances represent the current balance of an inclusive usage plan for a Customer, Site or Inventory

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

 - [GET /inclusive-usage-balances](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-pricing/inclusive-usage-balances/getinclusiveusagebalances.md)