In this topic:

Usage Rules

This guide covers Usage Rules and how they can be added and managed through the GTV Billing API.

Usage Rules are ordered and applied to subscription products to evaluate usage events based on the determined allowance, rate, and effective rule dates. For further detail on usage rules, we will take a look at rate tables and usage lookup tables which you will need for creating your usage rules.

In this guide, we will cover the following:

For more information on usage rules, please see the Gotransverse online documentation.

Types of usage rules

Usage rules are added to evaluate the subscription products with usage and can be created at three levels of the product lifecycle:

  • product: usage rules added to the specified product.
  • order-item: usage rules added to the specified order item.
  • service: usage rules added to the specified service.

Through the Billing API, you can add usage rules to order items and services. Usage rules can be added to the product only via the Gotransverse user interface.

Usage rule specifications

Usage rule specification can be of three types:

  • Match-all: usage rules are used in rating the service no matter what type of information is specified in the usage record.
  • Formula: usage rules contain the configured custom fields which determine whether the usage rule is used for rating.
  • Global: usage rules are used only together with the spreadsheet uploaded into the Gotransverse user interface. This spreadsheet determines when and how the service is rated.

Through the Billing API, you cannot create a Global usage rule, but you can view it when retrieving a product. Here is an example:


Usage rule rate types

The rate applied to the service or product can be of three types:

  • flat: applies a flat rate charge to each unit of measure.
  • pass-through: applies the rate from the event, therefore the rate "passes through" from the event instead of coming from formulas, rate tables, or lookup tables.
  • table: a charge rate from the configured rate table is applied.

Rule types

Tiered and tapered pricing strategies define prices for different quantity ranges.

  • Tiered pricing: a usage charge applied is based on the highest bracket achieved by the sum of all events. A tiered charge is a charge that is applied to the entity of the volume based on the last (or highest) bracket achieved by the volume of all events. For example, if tiers are set at $1.00 per for an allowance up to 10, $0.75 per for an allowance up to 20 and $0.50 for an allowance beyond 20, an amount of 25 would incur a total of $12.50.
  • Tapered pricing: a usage charge applied is only to items within a particular charge bracket. As each subsequent bracket is reached, a new charge increment is applied until the entire volume tapers off. The charge applied to an event is based on the bracket in which the event occurs. For example, if tiers are set at $1.00 per for an allowance up to 10, $0.75 per for an allowance up to 20 and $0.50 for an allowance beyond 20, an amount of 25 would incur a total of $20.00.

For the more detailed information and examples, refer to the Rule Types topic.

Top