Configure Base Buckets

Last Updated: Aug 04, 2020

Usage Buckets are configured in Settings / Usage Rating / Bucket & Share Plans / Base Buckets


Base buckets define the usage characteristics of buckets, such as the unit type that is being consumed (data, count, time), the class of usage that is applicable to the bucket (e.g. data, apis, disk space, voice, SMS) and the locations where usage is applicable to the bucket (Everywhere, North America, United States, etc.). Base buckets are selected when configuring usage buckets and share plan buckets. Usage buckets are attached to services and define the bucket size (1GB, 100 minutes, etc.), if the bucket recurs, and other settings which define how usage is included/charged in relation to a service or share plan.


Usage Classes need to be configured before base buckets can be setup.

Buckets Panel

The Buckets panel on the left of this screen allows you to select existing base buckets to view and edit on the Edit Bucket panel to the right. Actions are also available in this panel which are shown as icons above the Filter text box. The available actions are described below.




Deletes the selected base bucket if not in use (configured on usage buckets or share plans)

Adds a new base bucket

Buckets List

The buckets list on the left of the screen shows base buckets that are currently setup.

When you select a base bucket in the list additional details will be displayed in the Edit Bucket panel to the right. These details are explained below.

Edit Bucket Panel

The information in this panel reflects the currently selected base bucket. From here you can change bucket details (fields will display a red left border if a value is required and purple text if the field is read-only and cannot be modified).

Bucket Fields and Options:

  • Name: a descriptive name for the base bucket (e.g. 'Data Bucket')

  • Unit Type: how usage will be consumed for usage buckets that use this type of base bucket. The options are:

    • Count: usage by a specific activity/event (messages, events, records, etc.)

    • Data: usage by data consumption

    • Time: usage by time (e.g. call time/airtime)

  • Start Date: when the base bucket is active/available in the system

Bucket Details tab

This tab specifies the usage classes and locations that are applicable to the bucket. E.g. if you are setting up a base bucket for sms usage in the United States you would need to add bucket details with the appropriate messaging classes (e.g. SMS-MobileOriginating) and the appropriate locations (United States). Instructions on how to add details to the Bucket Details tab are covered in the guides section below.

References tab

This section displays where the selected base bucket is used in the system. By default the reference data is displayed in a summary format to indicate where the base bucket is in use, however the Entity drop down field can be used to view the exact system objects that the base bucket is configured on.