Activity Charge Rules

Activity Charge 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 activity rule.

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

  • Rule of the Formula type set to date01 less than 07/01/2020.
  • Flat Rate of $10 per gigabyte.
  • Recurring Allowance of 50 gigabytes.

In our example, for dates up to 07/01/2020, a customer is charged $10 for each gigabyte and they can’t use more than 50 gigabytes per service period.

You can add Activity Charge Rules to subscription products when creating an order or, later, on a service. Activity 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 activity rules. To view, create, modify, delete, and re-order activity rules, the Rule Override property on a product must be enabled.

Adding Activity Charge Rules

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

Adding an Activity Charge Rule on an Order

To add an activity charge rule when creating an order:

  1. Navigate to the desired billing account, then select Create Order from the account action menu.
  2. In the Order Items pane, next to the desired order item, hover over the configure icon, then select Activity Charge Rules.

    Note: If there are no items listed, use the Search bar or the Browse button in the Order Items pane to add order items.

    .
  3. In the Configuration window, under Activity Charge Rules, click Create Activity Rule..
  4. In the Create Activity Rule section, configure the details of the activity rule and proceed with creating an order.
    FieldDescription
    Name*Enter the name of the activity charge rule.
    Status*Select the status of the activity charge rule. Possible statuses include Active and Draft.
    Charge Category*Select the necessary charge category.
    Rule*

    Select the type of the activity charge 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 activity rule of the Formula type, select the desired custom field and operation symbol, then enter the desired value.

    Activity rule operations

    Activity charge 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.
    • 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 activity rule will use. After reaching the limit, the rule will not accept any more usage or will move to the next activity 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 activity rule has no upper usage limit, meaning this rule will always apply the rate to the usage event.
    • One Time: the activity 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 activity rule applies to the predefined limited recurring usage with the specified unit of measure. After selecting this option, you can also enable the following:
      • Prorate On Order—Select to prorate usage on order.
      • Prorate On Cancel—Select to prorate usage on cancellation.
      • Roll Over—Select to roll over the unused quantity of the usage to the next service period.
  5. To save the activity charge rule, click Create. Alternatively, click Cancel to discard your changes.
  6. After you create the activity charge rule, click OK to return to the Create Order page. Alternatively, click Cancel to discard your changes.

Adding an Activity Charge Rule on a Service

To add an activity charge rule on a recurring service:

  1. Click the Services tab on a billing account, then click a desired service in the Recurring Services pane or One-Time Services pane.
  2. On the Service detail page, select Create Activity Rule from the service action menu.
  3. In the Create Activity Rule window, configure the details of the activity rule.
  4. To save the activity charge rule, click Create. Alternatively, click Cancel to discard your changes.

Editing an Activity Rule

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

  1. To edit an activity 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 Activity Charge Rules.
    • On a service:
      • 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 Activity Rules detail tab. Next to the activity rule, under Actions, click the ellipsis button , then select Edit.
  2. In the Configuration window, on the Activity Charge Rules tab, next to the desired activity rule, click the edit icon, then edit the necessary fields that may include:
    • Name*—Modify the name of the activity rule.
    • Status*—Change the status of the activity 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 activity rule, but you can’t change the Flat type of Rate to Table Rate or Pass Through.
  3. To save your changes, click Edit. Alternatively, click Cancel to discard your edits.
  4. To close the Configuration window, click OK. Alternatively, click Cancel to discard your changes.

Deleting Activity Rules

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

Deleting an Activity Rule on an Order

To delete an activity 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 Activity Charge Rules.
  2. In the Configuration window, under Activity Charge Rules, click the delete icon next to the activity rule that you want to remove.
  3. Click OK. Alternatively, click Cancel to discard your changes.

Deleting an Activity Rule on a Service

To delete an activity rule on a service:

  1. On the Services tab, click the Activity Rule detail tab, and, next to the required activity rule, under Actions, click the ellipsis button , then select Delete.
  2. In the Confirmation window, click Yes.

Prioritizing Activity Charge Rules

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

  1. To change the order of the activity 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 Activity Charge Rules.
    • On a service: on the Services tab, click the Activity Rules detail tab.
  2. Click the up or down arrow icons to change the order in which activity rules are applied.
    • —Move the activity rule up in the priority list.
    • —Move the activity rule down in the priority list.

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

Viewing Activity Charge Rules

You can view existing activity charge rules:

For API 2.0 Usage rule documentation, visit our API reference documentation and our Usage Rules API guide. The term Usage Rule in our API is synonymous with Activity Charge Rule.