# Elevate Products API

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


Version: 2.13

## Servers

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

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

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

## usage-products

Usage products represent products that are billed based on usage

### Get a list of available usage products

 - [GET /usage-products](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/usage-products/getusageproducts.md)

### Create a new usage product

 - [POST /usage-products](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/usage-products/createusageproduct.md)

### Check if usage product exists

 - [HEAD /usage-products](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/usage-products/checkusageproduct.md)

### Get a specific usage product

 - [GET /usage-products/{usage_product_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/usage-products/getusageproduct.md)

### Update a usage product

 - [PATCH /usage-products/{usage_product_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/usage-products/updateusageproduct.md)

### Get a list of available usage product categories

 - [GET /usage-product-categories](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/usage-products/getusageproductcategories.md)

### Returns a list of available suppliers

 - [GET /usage-product-suppliers](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/usage-products/getusageproductsuppliers.md): Returns a list of available suppliers and corresponding data sources for usage products

## rental-products

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

### Get a list of available rental products

 - [GET /rental-products](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-products/getrentalproducts.md)

### Create a new rental product

 - [POST /rental-products](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-products/createrentalproduct.md)

### Check if rental product exists

 - [HEAD /rental-products](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-products/checkrentalproduct.md)

### Get a specific rental product

 - [GET /rental-products/{rental_product_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-products/getrentalproduct.md)

### Update a rental product

 - [PATCH /rental-products/{rental_product_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-products/updaterentalproduct.md)

## custom-fields

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

### Get a list of available custom fields

 - [GET /product-custom-fields](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/custom-fields/getproductcustomfields.md): Get a list of available custom fields for usage, rental products and rental product inventories

## rental-product-category

Rental product categories are used to group rental products together

### Get a list of available rental product categories

 - [GET /rental-product-categories](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-product-category/getrentalproductcategories.md)

### Create a new rental category

 - [POST /rental-product-categories](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-product-category/createrentalcategory.md)

### Get a specific rental product category

 - [GET /rental-product-categories/{rental_product_category_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-product-category/getrentalproductcategory.md)

### Delete a rental product category

 - [DELETE /rental-product-categories/{rental_product_category_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-product-category/deleterentalproductcategory.md)

### Update a specific rental product category

 - [PATCH /rental-product-categories/{rental_product_category_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-product/rental-product-category/updaterentalproductcategory.md): Update a specific rental product category