Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Usage Rate Plans are configured in Setup / Usage Rating / Usage Rates / Plans

Overview

Rate plans can be attached to various entities in the system (accounts, packages, services, etc.) and are used to determine the rates charged for usage. Rate plans contain rate groups and rate groups contain rates, by selecting from the available rate groups you can quickly create rate plans with all the included rates desired.

...

The information in this panel reflects the currently selected rate plan. From here you can change rate plan 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).

...

This tab shows rate groups that have been configured on the selected rate plan. From here you can add and remove rate groups as well as define the order/priority which the rate groups will be processed in during rating. See the guides pages beneath this article for rate group configuration instructions.

...

Adding Rate Plans

  1. At the top of the Usage Rate Plans panel click the (blue star) action button

  2. Populate the fields as desired. See the usage rate plans screen help for descriptions on each field

  3. To add a rate group to the plan click on the Group(s) To Add drop down list

  4. Type in the name of the group you wish to add in the list

  5. Click the +Add button to the right of the Group(s) To Add list

  6. Repeat the steps above to add all of the groups desired to the plan

  7. Set the order of the rate groups by clicking the arrows to the left of the group name or by dragging and dropping the groups into a new order. The rating engine will looked for rates in the groups from the top down. If a rate is not found in the first group in the list then the second group will be checked and so on. If no rate is found in the plan an exception will be logged for the usage that could not be rated

  8. When you have finished configuring the rate plan click Save

...

Editing Rate Plans

  1. Select the rate plan in the list on the left under the Usage Rate Plans heading or use the Filter text box to filter down to the rate plan you wish to edit

  2. The selected rate plan configuration will be displayed in the Edit Usage Rate Plan panel on the right

  3. Modify the rate plan fields as desired. See the usage rate plans screen help for descriptions on each field

  4. Add or remove rate groups if required

    • To add a rate group to the plan click on the Group(s) To Add drop down list, select all the groups you wish to add in the list and click the + Add button

    • To remove a rate group from the plan click on (blue star) to the right of the rate group and then click (blue star) to confirm that the group should be deleted. Existing groups on the plan that are selected for deletion will be displayed with strike through formatting. If you wish to deselect a group that has been tagged deletion click the (blue star) icon next to it

  5. Define the group priority by clicking the arrows to the left of the group name. The group at the top of the list will be checked first for applicable rates

  6. Click Save to commit your changes

...

Cloning Rate Plans

Info

Note: Cloning a rate plan is a quick way to create a new rate plan with a similar configuration to the plan being cloned. Cloning a rate plan will not result in groups under the plan being cloned, nor the rates within the groups. If you wish to clone a rate group and have all of the rates under the group cloned as well then you should use the clone function found on the rate groups screen.

  1. Select the rate plan you wish to clone in the list on the left under the Usage Rate Plans heading or use the Filter text box to filter down to the rate plan you wish to edit

  2. Click the (blue star) action

  3. On the pop-up that appears specify a NameDisplay Name and Amount Precision for the new rate plan.

  4. Click Clone

  5. On the Add Usage Rate Plan panel add, remove and set the order for the groups you require in the new plan

  6. Click Save

...

Deleting Rate Plans

Info

Note: Typically rate plans should not deleted. If you need to update rates you should:

  1. Import the new rate group(s) with the desired rates, or (if only a few rates need to be updated) clone the rate group which contains the rates you wish to update and modify the rates associated with the cloned group

  2. Attach the newly cloned/imported rate group(s) to the rate plan

  3. Remove the old rate group(s) from the rate plan

  4. Retire the old rate group(s)

If you created a rate plan in error and need to delete it first you will need to ensure it's not connected to other entities in the system (price plans, rate groups, services, packages, package-frequencies, accounts or owners). Once nothing is using the rate plan you can delete by doing the following:

  1. Locate the rate plan in the Usage Rate Plans list on the left

  2. In the same panel click the (blue star) icon

  3. On the confirmation dialog click Yes to confirm that the selected rate plan should be deleted