Skip to main content
Vindicia Knowledge Center

AutoBill Status and Entitlement Definitions

An AutoBill provides two pieces of Status explanation. The Billing Status field indicates the status of the AutoBill itself. A second field, Entitlement(s) Active indicates the status of customer entitlements associated with the AutoBill.

The following table lists possible status values for the AutoBill Billing Status.

 

Value

Explanation

Active

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

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 AutoBillobject or stopAutoBilling on the Account object; 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 that the customer who owns the AutoBill object is entitled until the AutoBill’s end-date.

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.

 

The following table lists possible status values for the AutoBill Legacy Billing Status.

Value

Explanation

New

AutoBill exists, but has not yet billed the customer.

Good Standing

Billing for the current billing period was successful.

Stopped

Customer opted out or the AutoBill was cancelled.

Hard Error

Billing for current period resulted in a hard failure. If the renewal date is past, the customer is not entitled to Product access.

Soft Error

Billing resulted in a soft failure, and will be resubmitted at the next retry cycle.

Pending

Transaction is authorized, but payment is not yet been captured.

A merchant application can configure whether Pending status results in customer Entitled or Disentitled status. For more information see AutoBills.

Pending Customer Action

Customer is currently redirected to the PayPal website for payment. Upon redirection to CashBox, Status will be set to New.

Upgraded

Customer upgraded or side-graded to a new AutoBill.

 

The following table lists the possible values for the AutoBill Entitlement(s) Active field:

Value

Explanation

Yes

Entitlements associated with the AutoBill are active.

No

Entitlements associated with the AutoBill are inactive.