Skip to main content
Vindicia Knowledge Center

AutoBill Object

AutoBill Object

AutoBill Object

The AutoBill object defines the relationship between an Account object (the customer description), an AutoBillItem object (the product(s) or service(s) purchased), and a BillingPlan object (the frequency and amount of the bill). An AutoBill describes the purchase by encapsulating the data members and methods that control the purchase terms, frequency, and rates for recurring billing, and any additional subscription information.

AutoBills usually encapsulate the terms of a recurring or renewable subscription. Although you may use AutoBills for one-time purchases (typically when an entitlement system is required), they are best handled with the Transaction object instead. For details, see The Transaction Object.

Once created, an AutoBill object automatically generates periodic Transaction objects within CashBox, according to the Billing Plan. CashBox processes those transactions with your payment processor. The status of a transaction determines the current status of the associated AutoBill object, which, in turn, affects the entitlements granted by the AutoBill to the associated Account object. Be sure to define entitlements with either BillingPlan or Product (or both) when creating an AutoBill object.

The constituent objects of an AutoBill object -- AccountAutoBillItem, and BillingPlan -- may be preexisting objects, in which case you can simply refer to them by their IDs when constructing the AutoBill. You may also create these objects along with the AutoBill object by specifying them inside the AutoBill object with new IDs.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top