Updated: September 6, 2021


The Usage Management Module implements the direct flow of the consumption/metering/pay-as-you-go data communication from Vendors to Distributors. This flow is referred to as the Usage Flow and it is is common for various businesses like Telecommunications, Infrastructure as a Service (IaaS), Platform as a Service (PaaS), Internet of Things (IoT), Managed Services and many others.

The Usage Flow is presented and highlighted in the following diagram:

This diagram showcases Vendors that generate and submit usage report files to their Partners by using the Connect platform. Thereafter, these usage report files are used by Distributors to bill their customers.

Note that the system enables Vendors to generate usage reports for reservation and pay-as-you-go items. Therefore, the Usage Flow may include the following processes:

  • Vendors can submit information on how items are being consumed. This scenario is applicable to the the Reservation items.
  • Vendors can submit data specifically for billing purposes. This scenario is only applicable for the Pay-as-you-go items and could be used for billing operations between:
    • Vendors and Distributors.
    • Distributors and their direct Resellers.
    • Distributors and their Resellers.
    • Resellers and their Customers.

The following introduces and describes different aspects of the Usage Management module on the CloudBlue Connect platform.

Video Tutorial

The following video tutorial introduces the Usage module and provides its overview:


Usage data can only be reported by Vendors in case the following requirements are met:

Product Capabilities

By default, product capabilities that enable Vendors to generate usage reports are turned off. Access the Capabilities section from your product profile page to switch on the following capabilities:

  • Consumption reporting for Reservation Items: With this capability your product will support the real-time reporting of the reservation items consumption.
  • Pay-as-you-go: This capability enables Vendors to implement the pay-as-you-go system and consequently define corresponding items on the product profile page. Once this capability is switched on, the system displays the following options:
    • Dynamic Items: This defines that Product reports dynamic items in the Usage File, i.e. the ones that were not pre-declared in the Product Definition.
    • Future Charges: Product can generate usage reports with charges assigned to future dates.
    • Predictive Estimates: Product supports predictive reporting of Consumption data within the Billing period before the actual Usage File.
    • Reporting Schema: An implemented usage schema that is explicitly declared in the product definition. The system includes Quantity, Multi-Tier Rated, Price Rated and Cost Rated schemas. Note that one product implements only one schema.

Refer to the Capabilities documentation for more details.

Reporting Schemas

A product with defined pay-as-you-go items can have one of the following usage reporting schemas supported by the Connect platform:

  • Quantity: Bill rate based on the item-level quantity information that Distributors receive from their Vendors.
  • Price Rated: Billing based on the item-level Tier-0 (End-customer) Price Information.
  • Cost Rated: Bill rate based on the item-level Level-0 (Distributor Cost) Price Information that they receive from their Vendors.
  • Tiers Rated: Billing based on the item-level Price Information that they receive from their Vendors for multiple Tiers.


The Usage module workflow and interactions between Vendors and Distributors are described and schematically illustrated below:

  1. Vendors collect raw data, i.e., information that should be normalized.
  2. Vendors specify required data by using an example template file.
  3. Vendors upload normalized usage report file to Connect. The system processes uploaded usage report file.
  4. Once the file processing is complete, Vendors can submit a report. Thus, the system transfers this file to the Pending state.
  5. Distributors review and accept the pending usage report file. In case of an error, Distributors can also reject this file.
  6. Export of records for billing either using record-level API calls or using the bulk file export.
  7. Received usage data is utilized by Distributors to bill their Customers or Resellers.
  8. Storing of reconciliation data either on a record-level or using the bulk file upload.

The following diagrams introduce the state-machine of the key usage module objects:

More Information

The usage module operations can be performed via the Connect user interface or by using the Usage API. Refer to the following articles for more information:

Is this page helpful?
Translate with Google
Copied to clipboard