Customer Hub Usage Information

If you are using the PeakCommerce Customer Hub, there is a feature that allows customers to easily view their current usage details.

Overview

If you are using the PeakCommerce Customer Portal, there is a special feature that allows customers with usage charges in their subscription to easily view their current usage details and units used on the My Subscriptions page.

To enable this feature in PeakCommerce, go to Company Settings > Company Information > Site Configurations > Subscription > Edit > Usage Plan (checkbox).

Please note that this feature will only appear on the My Subscriptions page if the subscription(s) have usage charges.

Display Location

There are two view options for usage charges.

  1. Top - The usage widgets will appear at the top of the My Subscriptions page for all usage charges
  2. With Subscription Information - The usage widgets will be nested within the subscription they are apart of next to the other charges.

You can change this setting for the tenant by navigating to Company Settings > Company Information > Site Configurations > Subscription > Edit > Usage Display Location.

Elements of the Widget

The Usage widget includes several fields that provide important information:

  1. Charge Name: This field displays the name of the charge in Zuora.
  2. Details Link: Clicking on this link opens the Usage Details page, where you can find more information about the usage.
  3. Current Service Period: This field indicates the current timeframe for which the usage is being collected, based on the billing period.
  4. Time Remaining: This field shows the number of days left in the current service period and a blue progress bar that visually represents the portion of time used for the entire service period.
  5. Units Used: This field displays the number of units used for the current service period, along with the unit of measurement (UOM).
  6. Included Units (when applicable): If the charge includes a certain number of units, this field will display the units used as a fraction of the total included units for the service period. It is accompanied by a green progress bar that indicates the portion of units used out of the total included units.

You have the option to customize the color of the two progress bars in either the Global or My Subscriptions Layouts. To do this, navigate to User Interface > Layouts > Global or My Subscriptions. You can override the style for the selector using the element provided below the customization options.

Usage Details

Clicking on the blue "Details" link within a Usage widget will take you to the Usage Details page, where you can view a table that includes all the usage that has been uploaded for this charge.

Table

The entries in the table can be filtered based on a specific date range of your choice.

The default details included in the Usage Details table are the Start Date, End Date, and Quantity. However, you can also add custom usage fields that have been created in Zuora to this table.

To manage the fields displayed in this table in the User Interface (UI), you can go to User Interface > UI Elements > and locate the Usages Table field. Click on the Edit option.

At the bottom of the pop-up window, you will find the option to import custom usage fields from Zuora. You will need to provide the custom field API name from Zuora and the display name for the corresponding column in the table.

In the Hide Columns window, all the usage fields that have been added from Zuora will be listed. You can select any fields that you want to exclude from the Usage Details Table. Additionally, you have the flexibility to change the sorting order of the fields.

Usage Export

In addition to viewing the Usage Details Table, you have the option to export the data. The table can be exported as an Excel or CSV file, and you can choose to export all of the data or a filtered view of the data.

The fields included in the export can be different from the fields included in the table. To customize the export, go to User Interface > UI Elements > and locate the Usages Table field. Click on Edit.

Below the Hide Columns window that was previously used for the table in the User Interface, you will find another Hide Columns (Export) window. All usage fields that have been added from Zuora will be listed. You can select any fields that you want to exclude from the Usage Details export. The fields included in the export do not have to match the fields from the table.

Caching

If you have made any changes to the Usage Details table or Export fields, it may be necessary to reset the Subscriptions Cache from Zuora in order for the new information to be synchronized. To request a cache refresh, please contact Customer Support.