TAG LINE
SMALL TITLE

Packages

Last Updated: Aug 06, 2020

Packages are configured in Setup / Product Catalog / Package / Packages

Overview

Packages are products/offerings that are added to accounts and billed. A package contains one or more services, the services are the individual line items that charges are configured on. A package's price is determined by summing the charges for the services within the package. Packages have a sub element called 'package frequencies' which allow you to setup multiple billing frequencies for each package that you create (for example a monthly billing version of the package and an annual billing version of the package).

When packages are added to accounts they are referred to as 'account-packages'. The term 'package' typically refers to a package in the product catalog, while the prefix 'account-' indicates that an instance of an object exists on an account.

Prerequisites

  • Services need to be configured before packages can be setup

  • Currencies need to be setup in order to enable currencies on package frequencies and specify service charges for the enabled currencies

  • Rate plans are required if you need to attach a rate plan to a service or package frequency

  • Contracts are required if you need to attach a contract to a package frequency

Packages Panel

The Packages panel on the left of this screen allows you to select existing packages to view and edit on the Edit Package 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.

Actions

Icon

Description

Deletes the selected package if not in use (added to an account)

Adds a new package

Packages List

The Packages list on the left of the screen shows packages that are currently setup.

When you select a package in the list any package frequencies under the package will be displayed. Selected packages will also show a (emoji) icon which allows you to add a new package frequency to the package. Details on the selected package's configuration will also be displayed in the Edit Package panel to the right. These details are explained below.

Edit Package Panel

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

Package Fields and Options:

  • Name: a unique name for the package. This name can be used as the customer facing product name on invoices and in web portals if desired

  • Start Date: the date that the package becomes active in the product catalog. If left empty the package will be available immediately

  • Expiry Date: used to retire a package. When this date is reached the package will no longer be available when adding packages to accounts. Account's already configured with the package will not be affected when the package expiration date is reached

  • Description: a description of the package for internal purposes or (optionally) details that can be presented on invoices or in web portals

  • Default Account Package Status: specifies the status the package will default to when it is added to an account. The package status determines if the account-package is billable and if package settings can be modified. See the package status help for more information on package statuses

  • Share Plan Add-On: converts the package to a share plan add-on package. When this setting is enabled the package will be an 'add-on' offering which can be added to account share plans to increase the available shared usage (e.g. add another gigabyte of data to the share plan). The services configured on the package which contain buckets will determine the amount and type of usage that the add-on package provides

  • One Time Billing: configures the package to apply service charges once only. When this option is set the billing option 'Charge Full Period' will be enabled. Once a one time account-package is billed its status will be changed to canceled

  • Currencies: sets the currencies that the package frequencies under the package can configure. E.g. if you select CAD and USD then the package frequencies setup under the package will only be able to configure USD and CAD prices

  • Billing Activation Service: allows you select a billing activation service which triggers account-package billing based on usage and/or time thresholds. See the services help for details on billing activation services and how to configure them

Services tab

This tab allows you to view, add, remove or edit services within the package. See the guides section below for instructions on how to perform these actions.

Billing Options tab

This tab allows you to define how the package is billed. The fields on this tab are explained below:

  • Charge Full Period: if enabled the package will always bill at its full package price (i.e. service charges related to the package will not be prorated). In addition, packages configured for full period billing will not provide refunds when the package is canceled

  • Charge Recurring Only If Usage: if enabled recurring service charges will only be applied when usage related to a service in the package occurs. Even if usage charges amount to zero the fact that usage occurred will result in recurring charges being applied. Enabling this option will result in the package being set as postpaid. Other non-recurring charges such as transition charges will still apply when this option is set

  • Postpaid: if selected, the package will be billed in arrears. Package charges will be applied for the previous period once the current period is reached. E.g. package charges for September will not be added to the account balance until the bill day in October is reached

Buckets tab

This tab will display any services within the package that contain buckets. Clicking on the (emoji) icon will reveal bucket details and allow you to configure buckets as shared. Shared buckets are available to be used by other usage based services in the package but will only be used after the services in the package have consumed their own buckets.

Custom Fields tab

This tab will display any custom fields that have been setup with an 'Entity' value of 'Packages'. Custom fields are used to capture/provide additional data and for packages typically this data is used for internal/back-end purposes. To allow or require users to enter data when adding packages to accounts you would setup custom fields with an 'Entity' value of 'Account Package'. See the custom field help for more information.