Skip to main content
Vindicia Knowledge Center

Billing Plan Details

Billing Plan Details

You can view detailed information about any Billing Plans you see listed on the Billing Plans List page.

The Billing Plan Details page lists specific information about the selected Billing Plan, and provides a link to the Edit Billing Plan page. (For more information, see Editing Billing Plans.)

Billing Plan Details Page

Note This page will show only those panes and fields relevant to the selected Billing Plan. For example, if the Plan does not include Season Sets, the Season Set fields will not be included. If the Plan does not include Entitlements, the Entitlements pane will not be included.

A Billing Plan may have multiple billing periods. The order in which they are listed is the order in which they will be in effect for the Billing Plan.

Click Entitlements or Merchant Data (if available) to show or hide additional information associated with the plan.

For more information about Billing Plan fields, see CashBox Billing Plan Parameters below.

Field

Definition

Billing Plan ID

RequiredYour unique ID for the Billing Plan.

Once created, do not change the Billing Plan ID unless absolutely necessary, as existing records in the CashBox database may reference the current ID.

You may not reuse a previously assigned Billing Plan ID when creating a new Billing Plan. If you attempt to do so, CashBox will return an error message and will not create the new Billing Plan.

Billing Statement ID

A payment-processor specific identifier, that is sent with Transactions generated using this Billing Plan. This identifier must conform to the payment processor's rules. The payment processor uses this value to determine the text that is displayed on the customer's credit card statement associated with the transaction.

A Billing Statement ID entered when creating a Billing Plan may be subsequently overridden by a Billing Statement ID specified in the Product, AutoBill or Transaction.

Do not change this value unless your payment processor requests it.

Merchants who use GlobalCollect, MeS, Litle & Co. or Chase Paymentech for payment processing can use this field to provide payment processor-specific information.

For more information, see the CashBox Programming Guide: Appendix A: Custom Billing Statement Identifier Requirements.

Description

Optional. An informative description of the Billing Plan.

Active

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

Use the Plan Active field as needed, for example, to control when a Billing Plan is available to associate with a Product or AutoBill.

End of Life

A date stamp to indicate when a Billing Plan is no longer available. If this field is empty, there is no end date for the Billing Plan.

Enter a date greater than or equal to today’s date, or click Today to insert the current year, month, and day.

Email before Billing

RequiredThe number of days prior to the end of a billing cycle that a pre-billing notification is sent to a customer. If Email before Billing is set to 0 (zero), then a pre-billing notification is not sent for this Billing Plan.

Tax Classification

Optional. Use the Tax Classification field to specify the tax classification applicable to any plan-level charges (that is, prices associated with the Billing Plan directly, not those from individually priced AutoBill Items).

A null value in this field causes CashBox to use the tax classification assigned to the Primary Product, which is the first active AutoBill Item on a given AutoBill. If you put a dash (–) in this field, no tax classification is assigned, leaving any tax calculation to the default or other applicable rules as defined within the Tax Service (that is, Avalara or Vertex). For example, The Billing Plan Identifier can be configured in Avalara's AvaTax as a "Tax Item", which will allow local override of the taxes charged for the Billing Plan-related charge.

Currencies / Tokens

Required. The payment method used by the Billing Plan: Currency (the default), orTokens.

Billing Periods

Required. The parameters for individual Billing Periods within the Billing Plan. Billing Periods set the length of time in a billing cycle, the cost per cycle, and specify notification milestones for each Period. For more information, see .

Billing Periods are listed in the order in which they will be processed for the Billing Plan.

If the Billing Plan is not associated with an active AutoBill, Billing Periods may be edited. If the Billing Plan is in use by an active AutoBill, only the Cost per Cycle may be modified.

Cycle Length

RequiredThe duration of the billing cycle. Length is specified as a number of days, months, or years. For example “8 Day” specifies an eight-day billing period.

If the Billing Plan is in use by an active AutoBill, this field may not be edited.

Number of Cycles

RequiredThe number of times this Billing Cycle will repeat within the Billing Period.

If the Billing Plan is in use by an active AutoBill, this field may not be edited.

Free

Selecting this checkbox marks the Billing Period as Free, regardless of the Products associated with it in an AutoBill. For more information, see Creating an AutoBill on an Account.

Price per Cycle

RequiredOne or more amount/currency or token/quantity pairs that define the price charged the customer for the billing period.

If the Billing Plan is transacted in currency, then each currency type appears only once in a billing period.

Default type is USD or _VT.

If the Billing Plan is priced in tokens, then each token type appears only once in a billing period, and only one token type may be used to bill in each cycle.

Email on 1st Bill

Required. Indicates whether a notification is sent to the customer for the first billing period. Default is No, meaning no notification will be sent.

If the Billing Plan is in use by an active AutoBill, this field may not be edited.

Email before Expiration

RequiredThe number of days before the Billing Period ends that an Expiration notice should be sent to a customer. This field is related to the Send Email on Expirationsetting in an AutoBill. For more information, see AutoBills.

If the Billing Plan is in use by an active AutoBill, this field may not be edited.

Season Set

The Season Set associated with the Billing Plan, if applicable.

Entitlements are active...

or

Continue Entitlement...

By default, Entitlements are active only during the defined Seasons. (If a Season Set is associated with the Billing Plan, these fields may be used to extend Entitlement access either days before and after a defined Season, or continuously during the Off Seasons.)

Run the set of Billing Periods

RequiredThe number of times the listed Billing Periods will be repeated within the Billing Plan. Select unlimited to repeat the sequence indefinitely.

This Billing Plan grants Entitlements for ...

The length of time the Entitlements for this Billing Plan will remain Active. Use this option to separate Entitlement grants from the Billing schedule.

This option is available only if the Billing Plan is defined for a limited time period. If the Billing Plan is unlimited, this option is not available.

Entitlements

Optional. Lists Billing Plan Entitlements. Entitlements may be used to specify access rights associated with the Billing Plan. For more information, see .

Custom Billing Plan Data

Optional. Lists custom Billing Plan information. For more information, see Working with Custom Data.

Cashbox Features

Learn More
Cashbox Features

For Developers

Learn More
For Developers
Back to Top