Skip to main content
Vindicia Knowledge Center

AutoBill status Data Member Detail

AutoBill status Data Member Detail

AutoBill status Data Member Detail

AutoBill status provides a clear and mutually exclusive indicator of the current service status of an AutoBill, and of its place in its life cycle.

The table below describes the enumerated values of the status data member of the AutoBill object. The Status Flow Diagram below illustrates the path a typical AutoBill follows in its life cycle, as well as special system statuses it can have.

Values

Description

Active

The AutoBill is actively granting entitled service and billing in accordance with the assigned Billing Plan and associated AutoBill Items.

See the Status Flow Diagram below for an illustration of Active AutoBill states.

Bogus AutoBill Status

For internal use or test purposes.

Canceled

The AutoBill is no longer actively granting service. It has been canceled due to user, merchant, or system action—for example, the customer has opted out of recurring billing or canceled the service; you have called cancel on the AutoBill object or stopAutoBilling on the Accountobject; or if a chargeback is received against a transaction generated by the AutoBill object.

Canceled is a terminal and permanent status. The Billing condition of this AutoBill is clarified by the current Billing State.

Note The customer who owns the AutoBill object is entitled until the AutoBill’s end-date.

(For for a flexible and automated way to indicate why an AutoBill is canceled, see the CancelReason Subobject. See also discussions of Cancel Reason Codes in the CashBox Programmer’s Guide and the CashBox User Guide.)

Deleted

The AutoBill was administratively removed—the content of this status can only be displayed in custom and specialty reports.

Dryrun

The AutoBill was temporarily created in service of a dry run—it will not be available beyond the duration of the dry run.

Expired

The AutoBill is no longer actively granting service—its fixed or non-recurring plan has ended and no further billing is scheduled or possible.

Legacy Suspended

This status is used in limited scenarios for legacy AutoBills that ended with a Hard Fail status but which did not otherwise meet the conditions of the new status values.

Pending Activation

The AutoBill has been fully created, has a start date that is in the future, and has not yet granted entitled service and is not yet billing. The AutoBill start date can still be changed.

Pending Cancel

The AutoBill is Active but scheduled for cancellation. The AutoBill will leave active service at the current end date.

Processing

The AutoBill is newly created and still being administratively defined. It is not currently providing entitled service and is not yet billing. Typically this status will be Pending Activation: the AutoBill has been completely created but has a future start date. The AutoBill is not yet granting entitled service and is not yet billing. The AutoBill start date can still be changed.

Unknown

For internal use or test purposes.

Upgraded

A terminal status given to an older version of an AutoBill that has been explicitly transitioned using the AutoBill.upgrade() API method.

Status Flow Diagram

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top