Skip to main content
Vindicia Knowledge Center

BillingPlanPeriod Subobject

BillingPlanPeriod Subobject

BillingPlanPeriod Subobject

Describes a quantity of time and a set of prices to use for the BillingPlan. The illingPlanPeriod Object Data Members appear in the table below.

Data Members

Data Type

Description

cycles

int

The number of billing cycles that pertain to this billing period. Set the value to 0 to specify an infinite number of billing cycles; set it to 3 to use this billing-plan period three times in succession.

doNotNotifyFirstBill

Boolean

A Boolean flag that, if set to true, prevents the prenotification email message from being sent. Use this flag to prevent email notification for the first bill after a free trial, for which an expiration warning message has already been sent.

expireWarningDays

int

The number of days before the expiration of this billing period to send a warning by email. CashBox sends the warning X number of days before the expiration date, where X is the value specified in this attribute.

free

Boolean

A Boolean flag that, if set to true, guarantees that CashBox will not bill for the AutoBill’s Products, regardless of whether they are added or included. CashBox will, however, bill for Charges explicitly added during the period.

Note Setting this flag to true causes CashBox to ignore any price defined elsewhere for the Billing Period, and set the period to free.

prices

BillingPlanPrice[]

The price of this billing period, in a specific currency or token type, but not both. The actual price for the transactions generated for the associated AutoBill object depends on the price picked from this array that matches the currency on AutoBill.

See the BillingPlanPrice Subobject.

quantity

int

The number of units of the billing period type to count as a single billing period. For example, for a biweekly billing cycle, set this value to 2 and BillingPlanPeriodType to Week. (Default is 1.)

type

BillingPlanPeriodType

An enumerated string that specifies the unit (day, week, month, or year) for the duration of the billing period.

Note For rolling promotion campaigns spanning multiple billing periods, the billing terms must be homogeneous. You cannot offer a rolling campaign if the Billing Plan has varied term lengths. Free cycles are ignored.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top