Skip to main content
Vindicia Knowledge Center

Active AutoBill Detail Report

Active AutoBill Detail Report

This report provides a list of active AutoBills within a specified time window, with detailed information about each Item on that AutoBill. The report provides a snapshot representing the current state as of run-time and displays a detailed view of the status and condition of every subscription, and of the individual products purchased. You can run this report on demand or on schedule, in HTML format or downloaded as a CSV file.

In HTML, the report provides a grouped representation of each active AutoBill. The CSV version is designed to be programmatically consumable, and has a row for each AutoBill Item, with the owning AutoBill details repeated. You can apply grouping or pivoting to the resulting file for AutoBill level counts.

Enter a date range and other preferences, select Display Columns and click Submit to generate the report.

Report Setup

The Active AutoBill Detail report shows multiple items for a single AutoBill.

Active AutoBill Detail Report

The following table describes the fields of the Active AutoBill Detail report.

Field

Description

AutoBill ID

Unique, merchant-assigned identifier for the AutoBill.

AutoBill Name

Descriptive merchant-assigned name to identify the AutoBill on customer Billing Statements.

AutoBill Status (Deprecated)

Status of a legacy AutoBill. Status for the AutoBill Status (Deprecated) include:

  • New
  • Good Standing
  • Soft Error
  • Hard Error
  • Deferred
  • Stopped
  • Pending
  • Upgraded
  • Pending Customer Action

This field represents the AutoBill Billing Status, not its Entitlement status.

AutoBill Status

Current Status for the AutoBill. Values include:

  • Unknown
  • Deleted
  • Processing
  • Pending Activation
  • Active
  • Pending Cancel
  • Cancelled
  • Expired
  • Upgraded
  • Legacy Suspended
  • Bogus AutoBill Status
  • Dryrun

 

AutoBill Billing State

Administrative state of an AutoBill. The billingState field contains the following values:

  • 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: Cancelled.
  • 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 direction. No further billing is planned.
  • Legacy Unknown BillingState: a very old state that does not map to any current AutoBill state.
  • Bogus BillingState: used for debugging.
  • 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).

Entitled

Indicates whether the AutoBill is actively granting service.

Billing Plan

Name of the billing plan for this AutoBill.

AutoBill Start Date

Date this AutoBill becomes active.

AutoBill Entitled-Thru (End Date)

The date through which the AutoBill will grant service—its termination date.

Billing Day

Paticular day of the month on which billing occurs.

AutoBill

Created Date

Date the AutoBill was created.

AutoBill VID

Vindicia, Globally Unique Identifier, CashBox assigns to an AutoBill and returns in response to an API call, upon creation of the AutoBill object.

AutoBill Plan Campaign ID

Campaign Code for a product on an AutoBill.

AutoBill Next Billing Date

Year, month and day on which the next billing occurs.

Customer ID

Unique merchant-assigned Account identifier.

Customer Name

Name a customer enters when creating an Account.

Affiliate ID

Your free-form string (if any) for the affliate who submitted this AutoBill object.

Subaffiliate ID

Your free-form string (if any) for the subaffliate who submitted this AutoBill object.

Item Number

Identifying number of an item in an AutoBill.

Merchant AB Item Identifier

Merchant-assigned AutoBill identifyer.

Product ID (SKU)

The Product ID from the AutoBill, or as specified in the Transaction—the stock keeping unit (SKU).

Item Quantity

Quantity of like items in an AutoBill

Currency

Currency type for the AutoBill

Amount

Amount charged for an item.

Item Campaign ID

Campaign Code for the item.

Item Added Date

Date the item was added to the AutoBill.

Item Start Date

Date CashBox begins charging for a service.

Item Removed Date

Date an item is removed from service.

Specified Cycles

The number of billing cycles for an item or AutoBill.

Remaining Cycles

The number of billing cycles remaining for an item or AutoBill.

Transitioned From

Unique (Vindicia or merchant) identifier of the AutoBillItem this item replaced as the result of an AutoBill.modify call.

Transitioned To

Unique (Vindicia or merchant) identifier of the AutoBillItem that replaced this item as the result of an AutoBill.modify call.

Vindicia item ID

Unique identifier assigned to an item by Vindicia.

Item VID

Unique identifier assigned to an item by Vindicia.

Cashbox Features

Learn More
Cashbox Features

For Developers

Learn More
For Developers
Back to Top