Rating Overview

Rating Record Structure 

Below illustrates how variable data reaches Charges on the Subscription Item. This series of records allows a given Subscription Item to ingest only the most appropriate data points for generating Charges. 

There are 4 main configurations in place to capture and calculate Charges for variable data:

Saved Search: The search that collects data from records (native or custom) for the Rate Plan Search Map.

Rate Plan Search Map: The Rate Plan Search Map will determine how to interpret search data. This record filters Saved Search data and identifies key data points such as Quantity, Usage Dates, Amounts, and Usage Type (Count of Consumption). Learn more here.

Rate Plan: The Rate Plan applies additional rating and pricing logic to variable data. It will determine how the Rate Plan Search Map is used with additional features such as Tier Achievement, Proration rules and Pricing Type Calculations. Learn more here. 

Subscription Item: The Subscription Item evaluates usage data and applies rating logic supplied by the Rate Plan and Subscription Item fields, in order to calculate and create Charges. 

Mapping the Rating Process

To build out the rating record structure follow the steps below:

Step 1. Create a Saved Search

1. Go to Lists > Search > Saved Searches > click New Saved Search 
2. Select any Native, Custom, ZAB Usage, Count Data, or Ad Hoc record > Give the Search a Title > check the box Public > under Results, Usage specific fields will populate for ZAB Usage/Count Data records
   • If using Native or Custom records ensure there are columns representing Quantity, Date, Effective Date (for Count) and End Date (for Count)
3. Take note of which column will represent the Quantity used for any pricing calculation (count the columns to identify the column number for Quantity) 

Tip: To avoid having to manually count your columns, add custom labels to the Saved Search Column Fields, numbering and describing the field. e.g. 1. ID, 2. Script ID, 3. Date, etc.

Step 2. Create a Rate Plan Search Map 

1. Go to Setup > Zone Advanced Billing Maps/Definitions > Rate Plan Search Map > New
2. Enter the Name
3. Select the Saved Search you have created
4. Specify whether this Rate Plan Search Map is being used for a Quantity and/or Tier Achievement Search.
   • Note: If setting this Rate Plan Search Map as the Quantity Search on the Rate Plan, you must select Quantity. If setting this as the Tier Achievement Search on the Rate Plan, select Tier Achievement
5. Select the Record Type you are using to store the Usage, Count, or Ad Hoc data, and whether the record contains Usage, Count, or Ad Hoc data.
   • If Usage Data:
     • Select the Date field on the Usage record that aligns with the Charge Period.
   • If Count Data:
     • Select the Effective/Start Date AND End Date fields on the Usage record that align with the Charge Period.
   • If Ad Hoc:
     • Select the Date, Subscription Item, and Charge fields to filter by on the Ad Hoc record
6. Select the column in your Search results which represents the Quantity.
7. Optionally define additional fields that should map to the Charge records.
8. Define the Filter Mapping to determine how the Search results should be “matched” to the Subscription Item.

Step 3. Create a Rate Plan 

1. Go to Setup > Zone Advanced Billing Setup
2. Select Rate Plan > New
3. Name the Rate Plan and select the Quantity Search it should reference
   • If using a Tier Achievement Rate Plan, also select the relevant Tier Achievement Search
4. Select the Pricing Type Calculation that should be used
   • Note this is only relevant if using a Price Book
5. The Rating Priority will default to 0. If this Rate Plan is dependent on another Rating process running first, set the Priority accordingly
6. Optional fields include: Quantity Proration Type, Description Override, Use Usage Data Description, Do Not Create Charges, and Show Charges by Tier

Learn more about Rate Plans here.

Step 4. Add a Rate Plan to your Subscription Item

Rate Plans assist in Rating variable data. A Rate Plan is required when a Subscription Item is using one of the following Rate Types: Usage (Variable), Fixed (Recurring) & Usage (Variable), Prepaid Item Quantity, or Prepaid Subscription. 

1. Go to your Subscription Item
2. Click Edit
3. Select a Rate Type 
4. Select a Rate Plan
5. Depending on the Rate Type selected, additional fields may be required. To learn more about configuration, visit the Rate Types guide.
6. Save
7. Once saved, generate charges for your usage by clicking the Rate Now button.