Usage Rules

Usage Rules are applied to subscription and add-on products to evaluate usage events based on the determined allowance and rate. They detect a condition within a usage event and evaluate whether this condition is met. In other words, the rate is applied only if the consumed usage matches the associated usage rule.

For example, a customer ordered internet service and a provider uses a usage rule to govern the contract conditions. The usage rule consists of:

  • Rule of the Formula type set to date01 less than 03/12/2021.
  • Flat Rate of $10 per gigabyte.
  • Recurring Allowance of 50 gigabytes.
  • Recurring interval of 3.
  • Rollover is enabled.

In our example, for dates before 03/12/2021, a customer is charged $10 for each gigabyte and they can’t use more than 50 gigabytes total every three service periods. The Recurring interval value of 3 sets the number of service periods that would need to complete before the bill cycle resets or regrants allowances to the service. Selecting Rollover means any unconsumed allowance will be rolled over to the service periods of the next recurrence interval during the bill cycle run. Any unconsumed allowance would be rolled over to the immediate next open service period after the allowance was issued if we were using a one-time allowance in our example or if the recurrence interval was set to 1.

You can add Usage Rules during product creation in UI 1.0, or add them to subscription products when creating an order or, later, when adding a usage rule to an active service. Usage rules are executed according to a specified priority which can be changed on an order or a service.

When needed, you can also edit or delete existing usage rules.

Note: To view, create, modify, delete, and re-order usage rules, the Rule Override property on a product must be enabled during product creation. It allows for overriding the default rules configured on a product at the time of order.

Note: If the system setting Create Job that Initiates the Gotransverse Rerate Function is set to True, you cannot save or update a usage rule with a recurrence interval greater than 1.

Adding Usage Rules

You can add usage rules to subscription or add-on products with the Rule Override property enabled. Usage rules can be added when creating an order or, later, on a service.

Adding a Usage Rule on an Order

To add a usage rule when creating an order:

  1. Navigate to the desired billing account, then select Create Order from the Account action menu.
  2. Select a Product Name in the Order Items pane. The product is added as an order item.
  3. In the Order Items pane, to the right of the desired order item, hover over the configure icon, then select Usage Rules.
  4. In the Configuration window, under Usage Rules, click Create Usage Rule.
  5. In the Create Usage Rule section, configure the details of the usage rule and proceed with creating an order.
    FieldDescription
    Name*Enter the name of the usage rule.
    Status*Select the status of the usage rule. Possible statuses include Active and Draft.
    Charge Category*Select the necessary charge category.
    Rule*

    Select the type of the usage rule:

    • Match All—Used in rating the service no matter what type of information is specified in the usage record.
    • Global—Used only together with the spreadsheet uploaded into the Gotransverse user interface. This spreadsheet determines when and how the service is rated.
    • Formula—Used when the configured custom fields match the usage event. To configure usage rule of the Formula type, select the desired custom field and operation symbol, then enter the desired value.

    Usage rule operations

    Usage rules are configured using the following operations:

    • =” (equals)—Usage rate is applied only if the usage equals the specified value.

    • <>” (not equals)—Usage rate is applied only if the usage does NOT equal the specified value.

    • >” (greater than): usage rate is applied only if the usage exceeds the specified value.

    • ” (greater than or equals)—Usage rate is applied only if the usage exceeds or equals the specified value.

    • <” (less than)—Usage rate is applied only if the usage is less than the specified value.

    • ” (less than or equals)—Usage rate is applied only if the usage is less than or equals the specified value.

    • Lookup—Usage rate from the specified usage lookup table entry is applied. Once selected, you have to specify the associated lookup table and lookup table entry.

    Rate*

    Select the rate applied to the product or service:

    • Flat—Applies a flat rate charge to each unit of measure. The number of digits that you can enter after the decimal point is defined by the Usage rating decimal precision system setting. Currently, the Rate cannot include more than 10 digits after the decimal point even if the is set to 11-20.
    • Rate Table—A charge rate from the configured rate table is applied. To create a new rate table, use GTV UI 1.0 or API 2.0.
    • 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.
    Allowance*

    Select the amount of usage the usage rule will use. After reaching the limit, the rule will not accept any more usage or will move to the next usage rule on the product to rate.

    Note: The selected type of allowance should be compatible with the unit of measure for the charge.

    • Unlimited—The usage rule has no upper usage limit, meaning this rule will always apply the rate to the usage event.
    • One Time—The usage rule applies to the specified one-time usage with the predefined amount and unit of measure. After selecting this option, you can select the Roll Over check box to enable rolling over the unused quantity of usage to the next service period.
    • Recurring—The usage rule applies to the predefined limited recurring usage with the specified unit of measure. You can select an interval value for the recurrence that’s greater than 1 (1 is the default). It will set the number of service periods that would need to complete before the bill cycle resets or regrants allowances to the service. For example, if you set the value to 3, the recurring allowance for the service would be granted after every three service periods.After selecting Recurring, you can also enable the following:
      • Prorate On Order—Select to prorate usage on order. If the recurrence interval in the Allowance section is greater than 1, the prorate applies across the usage rule interval. Also, there is no proration on roll-over allowance in this case.
      • Prorate On Cancel—Select to prorate usage on cancellation. If the recurrence interval in the Allowance section is greater than 1, the prorate applies across the usage rule interval. Also, there is no proration on roll-over allowance in this case. If billing has not happened for more than one service period in an interval, and the cancellation happens in one of the later service periods within the interval, the application will prorate the allowance on the first open period on the interval, and update the estimates for the remaining periods.
      • Roll Over—Select to roll over the unused quantity of the usage to the next service period if the default recurrence interval is set to 1. If you entered a value for a Recurring recurrence interval that’s greater than 1, the unconsumed allowance will be rolled over to the service periods of the next recurrence interval during the bill cycle run.

        Note: The Recurring interval option is not available for products with tiered rating usage rules where the recurrence interval is greater than 1.

  6. To save the usage rule, select Create.
  7. After you create the usage rule, click OK to return to the Create Order page.

Adding a Usage Rule on a Service

To add a usage rule on a recurring service:

  1. Select the Services tab on a billing account, then select a desired service in the Recurring Services pane.
  2. On the Service detail page, select Create Usage Rule from the Service action menu.
  3. In the Create Usage Rule window, configure the details of the usage rule.
  4. To save the usage rule, select Create.

Editing a Usage Rule

You can edit usage rules when creating an order or on a service.

  1. To edit a usage rule, do one of the following:
    • On an order: when creating an order, in the Order Items pane, hover over the configure icon, then select Usage Rules.
    • On a service, do one of the following:
      • On the Services tab, next to the desired service, under Actions, click the ellipsis button , then select Edit.
      • On the Services tab, select the desired service. On the Service detail page, click the Service Usage Rules or Product Usage Rules detail tab. Next to the usage rule, under Actions, click the ellipsis button , then select Edit.

  2. In the Configuration window, on the Usage Rules tab, next to the desired usage rule, click the edit icon, then edit the necessary fields that may include:
    • Name*—Modify the name of the usage rule.
    • Status*—Change the status of the usage rule which may include Active or Deactivated.
    • Charge Category*—Change the associated charge category.
    • You can also modify configurations of the Rule, Rate, and Allowance within the predefined type selected when creating the rule. For example, you can enter a new rate for the selected Flat Rate of the usage rule, but you can’t change the Flat type of Rate to Table Rate or Pass Through. Another example is that you can change the Amount of a Recurring Allowance, but not the type, like Byte. The Amount can be changed during the service period or recurrence interval period, but cannot be set to a value lower than the usage already billed in the interval or service period.
  3. To save your changes, select Edit.
  4. To close the Configuration window, select OK.

Deleting Usage Rules

You can delete usage rules when creating an order or a service. After you delete the usage rule, it’s no longer used to evaluate the related usage events.

Deleting a Usage Rule on an Order

To delete a usage rule when creating an order:

  1. On the Create Order page, in the Order Items pane, next to the desired order item, hover over the configure icon, then select Usage Rules.
  2. In the Configuration window, under Usage Rules, click the delete icon next to the usage rule that you want to remove.
  3. Click OK. Alternatively, click Cancel to discard your changes.

Deleting a Usage Rule on a Service

To delete a usage rule on a service:

  1. On the Services tab, click the Service Usage Rule or Product Usage Rule detail tab, and, next to the required usage rule, under Actions, click the ellipsis button , then select Delete.
  2. In the Confirmation window, click Yes.

    Note: For usage rules where a recurrence interval greater than 1 is configured and there is at least one closed service period in the recurrence interval, the usage rule for the closed service period and the recurrence interval will remain while the usage rules for the service periods which were not closed in the recurrence interval will be deleted. Recurrence intervals span service periods and rules are for each service period.

Prioritizing Usage Rules

You can change the priority of usage rules when creating an order or on a service. The priority determines the order in which usage rules are applied. A usage rule at the top of the list has the highest priority, meaning it will be executed first.

  1. To change the order of the usage rules, do one of the following:
    • On an order: when creating an order, in the Order Items pane, hover over the configure icon, then select Usage Rules.
    • On a service: on the Services tab, click the Service Usage Rules or Product Usage Rules detail tab.
  2. Click the up or down arrow icons to change the order in which usage rules are applied.
    • —Move the usage rule up in the priority list.
    • —Move the usage rule down in the priority list.

After you click the arrow icons, usage rules change position in the list accordingly.

Viewing Usage Rules

You can view existing usage rules:

For API 2.0 Usage rule documentation, visit our API reference documentation and our Usage Rules API guide.