Skip to main content
Vindicia Knowledge Center

AutoBill billingState Data Member Detail

AutoBill billingState Data Member Detail

AutoBill billingState Data Member Detail

The billingState data member presents the financial billing condition of an AutoBill. This data member expands on the current billing condition of the subscription, and in combination with the Status field, provides a definitive representation of the current condition of an AutoBill.

The table below describes the enumerated values of the billingState data member of the AutoBill object.

Values

Description

Unknown

For internal use or test purposes.

Unbilled

No billing has yet occurred for this AutoBill.

Good Standing

The AutoBill is in a billable state and has no overdue balance.

Free/Trial

The AutoBill’s current Billing Period definition (as specified by the current Billing Plan) is forcibly free. This can be a temporary state or for the duration of the billing period configured to be free—or permanent if the Billing Plan is permanently free. This state does not apply when the free condition is arrived at due to a Campaign application.

In Retry

The AutoBill is still active but in retry, and has at least one billing period in which there was a failed attempt to charge; the AutoBill is still within the configured retry period and may yet be saved by automated processes or customer action. This state corresponds to the prior Soft Error status. In the new scheme, it will only be paired with the Active status.

Unusable Payment Method

The AutoBill is still active but is in retry, and has at least one billing period in which there was a failed attempt to charge, and received an error code designated as a Hard Fail, which is expected to be unrecoverable. The AutoBill will remain in this state, in the expectation that a new payment method will be provided by the customer, until the specified retry, or grace period, expires.  This state corresponds to the previous Hard Error status when the AutoBill end date has not passed

Billing Completed

The AutoBill is not active; it successfully completed all required billing and has no further scheduled billings.

Failed To Collect

The AutoBill is no longer active, having exhausted the retry period without a successful payment method update. This state corresponds to the previous Hard Error status, in which the AutoBill end date has passed. This state will only exist for an AutoBill with the status: Canceled.

Overdue

The AutoBill is assigned a Merchant Accepted Payment (MAP) payment method (invoicing) and has at least one overdue invoice.

Pending Acceptance

The AutoBill uses a payment method that requires merchant or customer action before charges can be processed, and is waiting on that external action or approval.

Free Period

The AutoBill is currently in a free or $0 billing period for any period excepting a Free=True condition on the initial billing period only (which uses the Free/Trial state).

Terminated

The AutoBill has been forced into a terminal state by system or merchant action. No further billing is planned.

Leghacy Unknown BillingState

For internal use or test purposes.

Bogus BillingState

For internal use or test purposes.

Grace Period

The AutoBill has an unpaid balance and is in the retry period but has passed the last scheduled retry attempt—the only path to recovery is a successful payment method update (usually customer intervention).

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top