Skip to main content
Vindicia Knowledge Center

AutoBill Details

AutoBill Details

The AutoBill Details page lists specific information about the selected AutoBill, which includes customer and payment information, the current status of the AutoBill, its duration, and associated Products. The page also provides Billing Plan Details, a list of Entitlements, and Billing and Credit Information.

AutoBill Details Page

Release10.0.0 of the CashBox Portal provides new AutoBill Modify functionality for editing existing AutoBills using Edit AutoBill Item and Replace AutoBill Item (see CashBox AutoBill Parameters for definitions). Release 10.0.0 of the CashBox Portal meanwhile also has the ability to provide legacy, or “pre-modify” behavior on the Portal, to align with the primary API version used by your specific integration. The behavior you see on your portal is determined by a function-specific configuration managed by Vindicia Technical Support. If, due to the API version of your integration, you require the pre-modify behavior, contact Technical Support to request the change.

An excerpt of the AutoBill Details page below shows the pre-modify behavior, with the legacy Upgrade AutoBill button at the top of the page.

Note To upgrade an AutoBill from the AutoBill Details page using the pre-modify behavior, the AutoBill must be active and can not already have been upgraded

AutoBill Details Page Update

For definitions of all fields, see CashBox AutoBill Parameters.

From the AutoBill Details page you can view details about the customer Account or the Payment Method for the AutoBill, and view entitlements and custom data related to the Product and Billing Plan associated with the AutoBill. You can also EditUpgrade, and Make Payments to AutoBills.

  • Click the Customer ID to open the Account Details page for the Customer.
  • Click the value in the Payment Method field to open the Payment Method Details page.

The following table describes the fields available to AutoBills.

 

Field

Description

AutoBill Fields  

AutoBill ID

Your unique identifier for the AutoBill.

AutoBill Name

Your name for the AutoBill.

This is for your internal use, and is not the same as the description that will appear on your customers’ credit card statements.

Invoice Format

For Payment Method Type: Pay by Invoice, defines the format in which Invoices will be generated for your customers. For all other AutoBills, defines the format in which billing statements will be emailed to your customers.

  • Attachment sends statements as PDF attachments to the statement email.
  • Do Not Send does not send a statement.
  • Inline sends statements as inline plain text.

Net Terms

For Payment Method Type: Pay by Invoice, defines the number of days after the billing date that the Invoice will fall due.

For all other payment types, defines the number of days before a payment is processed that a billing statement will be sent to the customer.

Invoice Template

For Payment Method Type: Pay by Invoice, defines the template used for Invoices. For all other AutoBills, defines the (uploaded) template used for billing statement emails.

Affiliate ID

Optional. Custom text field, which may be used to track your affiliates.

Subaffiliate ID

Optional. Custom text field, which may be used to track your sub-affiliates.

Remaining Balance in Set

Calculates the remaining amount due for the current cycle of the Billing Period set. This amount does not include any repetitions of the Billing Periods defined for the Billing Plan.

This field will not be listed for AutoBills which contain infinitely repeating Billing Periods in the Billing Plan.

Remaining Payment in Set

The remaining number of payments due in the current Billing Period set for the Billing Plan.

Currency

Required. The ISO-4217 three-letter format for the default currency associated with the AutoBill.

For an AutoBill that is paid using tokens, Currency is displayed as _VT.

AutoBill Start Date

Optional. The date the AutoBill takes effect.

Use this value to specify when the AutoBill may be activated.

AutoBill End Date

Optional. The date on which the AutoBill will no longer be active.

This date is derived by adding the number of days in your retry cycle (as defined in your CashBox configuration) to the endTimestamp for the AutoBill. Do not use this field to change the End Date.

Bill Day

Required. The day of the month on which the AutoBill is set to bill. If you select a number greater than the last day of a given month, the AutoBill will bill on the last day of that month.

Send Email on Expiration

Sets whether a customer will be notified prior to an expiration date on the AutoBill (for example, prior to the end of a free trial period).

  • Yes: the default value, an expiration notification email will be sent if an expiration notification is configured for the merchant.
  • No: a notification will not be sent.

This field is related to the Expire Warning Days setting in a Billing Plan.

Coupon Code

Enter the Campaign Code to be applied to the AutoBill, if applicable.

Custom AutoBill Data

Lists any custom data defined for the AutoBill.

All name-value pairs included with an AutoBill will be automatically copied to any resultant Transactions.

For more information, see Working with Custom Data.

Customer Account Fields

 

Customer Name

Lists the customer associated with the Account.

Customer ID

Displays your unique ID for the customer Account associated with the AutoBill.

Payment Method

Required. The primary Payment Method for this AutoBill. Includes the Payment Method Type, and the (hashed) Credit Card number, and expiration date, if applicable.

For more information, see CashBox Payment Method Parameters.

Card Number

Lists the (hashed) Credit Card used to pay the AutoBill.

Legacy Billing Status

Displays the status of the AutoBill.

  • 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 has not yet been captured.
  • Pending Customer Action: Customer is currently redirected to the PayPal website for payment. Upon redirection to Vindicia, Status will be set to New.
  • Upgraded: Customer upgraded or side-graded to a new AutoBill.

This field is read-only.

Billing Status

Displays the current service status of the AutoBill.

  • 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.
  • Cancelled: 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.

Billing State

The financial billing condition of an AutoBill. Billing State 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.

Entitlement Active

Displays the status of the entitlements associated with the AutoBill, if any.

  • Yes: Entitlements associated with the AutoBill are active.
  • No: Entitlements associated with the AutoBill are inactive.

This field is read-only.

AutoBill Items Pane

 

Campaign Code

There are two Campaign Code fields in the AutoBill Items pane for the AutoBill. The field at the top of the pane applies the Campaign discount to all Products listed. The fields embedded within the Product information areas apply the discount only to the listed Product.

Product

Lists the Product ID.

Products are listed in the order in which they are added to the AutoBill.

The first Product listed is considered the Primary Product for the AutoBill, and is the Product associated with the AutoBill in the CashBox Dashboards and Reports.

Next Payment

The (estimated) next payment due for the Product.

Unless an override value has been entered for the Product, this field shows the price listed in the Product definition.

Total Cycles Left

The number of remaining Billing Cycles for which the Product will be included with the AutoBill.

Quantity

The number of units of a product that can be purchased in multiples. CashBox uses this number to determine the cost of the item to the customer. For license-based rated products, Quantity indicates the license count.

Replace AutoBill Item

Replace the current AutoBill item with a new item.

Edit AutoBill Item

Modify the existing AutoBill item details (such as pricing, quantity and cycles).

Start Date

The date the Product was, or will be active on the AutoBill.

Date Removed

The Date the listed Product was removed from the AutoBill.

Rated Unit

The Unit in which the Product is billed.

Rate Plan

The Rate Plan by which the Product is billed.

Billing Plan Pane

 

Billing Plan

Lists information for the Billing Plan associated with the AutoBill.

For more information on the fields listed, see CashBox Billing Plan Parameters.

Future Transactions Pane

 

Future Transactions

Lists (estimated) future billing transactions for the AutoBill, including the billing date, currency, and taxable amount. CashBox includes any applicable Campaign discounts in its calculations for Future Billings.

For more information on the fields listed, see Future Transactions.

Credits Pane

 

Credit

Lists any Credits associated with the AutoBill.

For more information on the fields listed, see Credits.

Cashbox Features

Learn More
Cashbox Features

For Developers

Learn More
For Developers
Back to Top