Usage Inputs
Usage Inputs are the records that capture raw, unrated consumption data (like internet consumption, data storage, medical equipment usage, utility consumption etc.) for usage-based products or services. These are the basic records for calculating what a customer should be billed for their actual usage.
A typical lifecycle of usage inputs involves - usage input creation, rating, estimating (optional for forecasting), unrating, and re-rating (if needed). They can also be cloned and deleted, if required.
Create Usage Inputs: You can create a usage input manually via the UI (not supported yet) or through an API. For usage input creation through an API, see Create a Usage Input.
- Rate based on quantity's price (for Dimension Value = Discrete): Each specific quantity has a unique price.
- Rate based on quantity's exact tier price (for Dimension Value = Range): The system finds the price tier the quantity falls into and applies that price.
- Rate based on fee per tier from the starting tier (for Dimension Value = Cumulative Range): The system sums up charges for all tiers up to the entered quantity.Note: The Dimension Value is is currently a part of the Product/Price List Item setup.
Unrating: Unrating reverses a previously rated usage input. This is essential if you need to correct errors (like wrong quantity or date). After unrating, the status changes to Unrated, and the Rated Amount is set to null. The BSR and Billing Header are updated to reflect the removal of the previously rated amount. Usage Inputs in Rated status can only be unrated when the corresponding BSRs are in Pending Billing status.
Estimating: Estimating a Usage Input is the process of forecasting or calculating a draft billable amount for a usage input before it is actually rated and finalized for invoicing. This is especially useful for revenue forecasting, giving the customers an idea of what the charges might look like based on current or projected consumption, without committing those amounts to billing.
Re-rating (if needed): After unrating, you can correct the data and re-rate the usage input. This ensures accurate billing for your customers.
The Usage Inputs page is organized into the following areas: the page header, the toolbar, and the records list. It also facilitates performing the usage input bulk actions (Rate, Unrate, and Estimate) and associated row level action for applicable line items .
The Page Header: The page header appears at the top and lists the title (Usage Inputs) and subtitle of the page.
Toolbar: The toolbar sits directly above the records list and provides filtering, search, and display options.
Records List: The records list displays all submitted usage input records in a tabular format. Each row represents one usage input. The following columns are available by default.
| Column | Description |
|---|---|
| Name | System-generated unique identifier for the usage input record. It is hyperlink to navigate to the usage inputs details. |
| Rating Status | Current processing state of the usage input. Possible values: Loaded, Rated, Unrated, Draft, and Error. |
| Rating Message | System message describing the outcome of the rating process. |
| Id | Unique system-generated ID associated with the usage input. |
| Type | Classification of the usage input. Regular is the standard type. |
| Submission Date | Date and time the usage input was submitted to the system. |
| Subscription Identifier Object | Specifies the type of record (object) that uniquely identifies the subscription or asset for which the usage is being recorded. Common values are AssetLineItem or OrderLineItem. |
| Subscription Identifier Record ID | ID of the subscription identifier object. |
| Quantity | Quantity for which the usage input is created, |
| Draft Quantity | A forecasted quantity for a usage input |
| Unit of Measure | Represents the magnitude or type of quantity being recorded for a product or service. It defines how the consumption is measured and billed — such as Each, Hour, Day, etc. |
| Rated Amount | The actual billable amount calculated for a usage input when it is Rated. This value is based on the pricing tiers, quantity consumed, and any applicable discounts or markups. This amount rolls up to the billing schedule records and subsequently to billing header. |
| Draft Rated Amount | A forecasted billable amount for a usage input, calculated before actual rating. It is used for revenue planning and validation, allowing the user to see what the billable amount would be if the usage input is processed, but without actually affecting billing schedule records. |
| Billing Schedule Record ID | The ID of billing schedule record associated with the usage input. |
- Rate a usage input: see Rating Usage Inputs.
- Unrate a usage input: See Unrating Usage Inputs.
- Estimate a usage input: See Estimating Usage Inputs.
Row Actions Menu: A three-dot actions menu (⋮) appears on hover for certain rows, depending on their status. Click this icon to access available record-level actions such as rating, unrating, and estimating the usage input.