Skip to main content
Vindicia Knowledge Center

Rate Plan Details

Rate Plan Details

The Rate Plan Details page lists information about a specific Rate Plan. To access this page, simply click the Rate Plan ID from any page on which it is shown.

Rate Plan Details Page

The following table lists and describes the parameters available to Rate Plans.

 

Field

Definition

Rate Plan ID

Required. Specifies a unique ID for the Rate Plan.

Do not change the Rate Plan ID unless absolutely necessary, as existing records in the CashBox database may reference the current ID.

Rate Plan Description

An informative description of the Rate Plan.

Unit

Select an existing Unit from the pulldown menu, or create a new Unit by defining both its singular and plural names. (These names will appear in customers’ Billing Statements.)

Active

Indicates whether a Rate Plan is active (Yes) or inactive (No).

Use the Active field to control whether a Rate Plan is available for use.

Model

Select a billing model: usage based or license based.

  • usage based: calculates the fee per Billing Cycle based on the number of Rated Units reported during the Billing Cycle.
  • license based: calculates the fee per Billing Cycle based on the last reported number of Rated Units for the AutoBill.

Charge Customer

Defines how the value entered in the Rate Price (Tier Price) field will be interpreted.

  • per unit calculates charges per individual unit (multiplies the number of units reported for a Billing Cycle, by the appropriate Tier Price).
  • flat fee calculates charges per Tier (charges the defined Tier Price, based on the number of reported units, without additional calculation).

Rate Price

The calculation method by which this Rate Plan will determine the price to bill for a Billing Cycle.

  • for each respective Tier multiplies the number of Rated Unit Events for the Billing Cycle by the Rate Price for the Tier in which they occurred.

    This method calculates the charge by Tier use. That is, if a Tiered Plan is defined as $2 for 0-9 units, and $1 for 10-100 units, a customer who uses 15 units will be charged $2*9 + $1*6 = $24.
     
  • to the highest applicable Tier multiplies the total number of Rated Unit Events for the Billing Cycle by the price for the Tier in which the total number occurs.

    For the 15 units used in the example above, this method would calculate the charge by multiplying 15 units by $1, for a total charge of $15.

Currencies/Tokens

The Currencies or Token Types for which the Rate Plan is defined.

Min Fee

The minimum fee that will be charged for every Billing Cycle, regardless of use.

Max Fee

The maximum fee that will be charged for every Billing Cycle, regardless of use.

Included Units

The number of Units that will be included with the Plan for each Billing Cycle. These Units will not be used in billing calculations, and are included with every Billing Cycle for the duration of the Plan’s application to a Product in an AutoBill.

Tier Levels have (decimal places)

Defines the number of decimal places to which CashBox will round reported Rated Unit Event totals. (This number affects the value displayed for the Begins at Level, as well as the manner in which CashBox will calculate Billing Cycle charges for Rate Plan priced Products.)

For example, given a total of 346.26961:

0: rounds to the nearest integer. (346)

2: rounds to the nearest hundredth. (346.27)

You may use the CashBox API to set this value to a negative number. While positive numbers round to the right of the decimal point, negative numbers round to the left of the decimal point.

For example: 

-2: rounds to the nearest hundred. (300)

Begins at Level

The first number of Units for which the price for this Tier in the Rate Plan will be applied. This number is calculated by adding the previous Tier’s Ends at Level, and a single unit as defined by the Tier Levels have value.

Ends at Level

The last number of units for which the price for this Tier in the Rate Plan will be applied.

Custom Rate Plan Data

Displays custom information associated with the Rate Plan.

For more information, see Working with Custom Data.

Cashbox Features

Learn More
Cashbox Features

For Developers

Learn More
For Developers
Back to Top