| Create/Edit View |
|
ID
| Your unique
identifier for this subscription. | Required |
|
Name
| Name of the
Subscription. This name is used for your internal use. It is not the
same as the billing description that will appear on your customers’
credit card statements. | Optional |
| Billing Description | Enter a meaningful description for the subscription. | Optional |
| Invoice Format | For Merchant Accepted Payment Payment Method,
this field defines the Invoice format generated for your customers,
select from the dropdown list. For all other Subscriptions, this field
defines the format in which billing statements are emailed to your
customers.- Do Not Send—no statement is sent
- Attachment—sends statements as PDF attachments to the statement
email
- Inline—sends statements as inline plain text
| Optional |
|
Invoice Template
| This field defines the (uploaded)
template used for billing statement emails. For Merchant
Accepted Payment Payment Method, this field defines the
template used for Invoices. | Optional |
| Affiliate ID | Custom text field, used to track the affiliate associated with the subscription. | Optional |
|
Sub-Affiliate ID
| Custom text field, used to track the s sub-affiliate associated with the subscription. | Optional |
|
Currency
| The currency associated with the subscription using the ISO-4217 three-letter format.
Select one currency from the drop-down menu. | Required |
| Start Date | The date the subscription starts its activity. | Required |
|
Billing Day
| The date of the month to bill the
subscription. If you select a number greater than the last day of
a given month, the subscription will bill on the last day of that
month. | Optional |
| Net Terms | Defines the number of days before a payment is processed that a
billing statement will be sent to the customer. For
Merchant Accepted Payment payment method,
it defines the number of days after the billing date that the
Invoice will be due.
| Optional |
| Minimum Commitment | The minimum number of billing cycles required for this subscription. If customers can leave
subscription at any time, leave as default - 0. | Optional |
| Send Email Before Expiration | Yes or No Toggle. The toggle indicates whether
to send a billing notification when the subscription is transitioning
from a free trial or expiring. If Yes is
selected, the billing notification is sent based on the billing plan
rule for the number of days to send before expiration. Default value is
No. | Optional |
| View
Only |
| Status | The current Subscription service status is displayed in the title bar of this pane. Possible
statuses are:
- 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.
| Read only |
| Created | The date the Subscription was created. | Automatic |
| Send Email Before Expiration | This is an indication whether a billing notification will be sent regarding the trial-end or
expiration of the subscription. | Read only |
| State | The current billing state of the Subscription. Its values are:
- 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.
| Read only |
| Balance | Outstanding balance amount of the subscription along with the national flag icon
representing currency. | Calculated |
| Entitled Through | The date through which the subscription is currently entitled (providing service). This
is typically updated after each successful billing event. | Read only |
| End Date | The date the subscription current service period ends.This
is typically updated after each successful billing event. | Read only |
