Subscription list | Use the arrow to expand the Subscription details. | Optional |
See all Subscriptions... | If the Subscription list for the customer's account is very long, a
link to access the full Subscription listing is provided. | Automatic |
ID | The unique identifier for the Subscription. Click the
Subscription ID to access the relevant
Subscription page | Required |
Billing Plan | The Billing Plan associated with the subscription. The billing plan serves as the
scheduling plan for the subscription. When the Subscription is
expanded, you can click the Billing Plan ID to access the relevant
Billing Plan page. | Automatic |
Product | The
product (also know as Subscription Item) associated with the
subscription. The Product Description is used by
default (English version). If several products are associated with the
Subscription, they appear as a row separated by commas.
Note: If the
Product does not include a description, the Product ID is
displayed. | Automatic |
Status | The
current service status of the subscription.
- Active: The Subscription is actively
granting entitled service and billing in accordance with the
assigned Billing Plan and associated Subscription Items.
- Cancelled: The Subscription is no longer
actively granting service. It has been cancelled due to user,
merchant, or system action—for example, the customer has opted
out of recurring billing or canceled the service; API calls to
cancel the subscription or stop billing on the Customer have
been made; or if a chargeback is received against a transaction
generated by the Subscription. Cancelled is a terminal and
permanent status. The Billing condition of this Subscription is
clarified by the current Billing State. Note that the customer
who owns the Subscription is entitled until the Subscription's
end-date.
- Deleted: The Subscription was
administratively removed—the content of this status can only be
displayed in custom and specialty reports.
- Expired: The Subscription 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 Subscriptions that ended with a
Hard Fail status but which did not otherwise meet the conditions
of the new status values.
- Pending Activation: The Subscription 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
Subscription start date can still be changed.
- Pending Cancel: The Subscription is
Active but scheduled for cancellation. The Subscription will
leave active service at the current end date.
- Processing: The Subscription 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 followed by Pending Activation
where the Subscription has been completely created but has a
future start date and is not yet entitled or billing.
- Upgraded: A terminal status given to an
older version of a Subscription that has been explicitly
transitioned using the AutoBill.upgrade() API method.
- Pending Pause: The Subscription is Active
but scheduled for pause. The Subscription will be paused on the
next pause start date. It will remain paused with no end
date.
- Paused: The Subscription is no longer
actively granting service or being billed. If no other action is
taken upon the Subscription (resume is not performed), it will
remain paused for 5 years, and then automatically move to
cancelled status.
| Automatic |
Billing Status | The billing status presents the financial billing condition of the Subscription. When used in
combination with the status field, it provides a definitive
representation of the current condition of a Subscription.
- Good Standing: Billing for the current
billing period was successful
- Free/Trial: The subscriptions 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 Subscription is still
active but in retry, and has at least one billing period in
which there was a failed attempt to charge; the Subscription 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 Subscription
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 Subscription 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 subscription end date has not passed.
- Billing Completed: The Subscription is
not active; it successfully completed all required billing and
has no further scheduled billings.
- Failed to Collect: The Subscription 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 Subscription end date
has passed. This state will only exist for an Subscription with
the status: Canceled.
- Overdue: The Subscription is assigned a
Merchant Accepted Payment (MAP) payment method (invoicing) and
has at least one overdue invoice.
- Pending Acceptance: The Subscription 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 Subscription 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 Subscription has been
forced into a terminal state by system or merchant action. No
further billing is planned.
- Grace Period: The Subscriptoin 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). The Subscription is still active and entitled
until the end of the Grace Period.
| Automatic |
Start Date and End
Date | Specifies when the subscription was activated and when it
ends. | Required |
Transactions | The five most recent transactions are displayed for each
subscription.- Click the transaction ID for the full
Transaction details.
- Click the See all transactions.. to access the main
Transaction listing Filter page
| N/A |