Your unique identifier for the Subscription
Your name for the Subscription.
Note: This is for your internal use, and is not the same as the description that will appear on your customers’ credit card statements.
An informative description of the Billing Plan.
For Payment Method Type: Pay by Invoice, defines the format in which Invoices are generated for your customers. For all other Subscriptions, 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
For Payment Method Type: Pay by Invoice, defines the template used for Invoices. For all other Subscriptions, defines the (uploaded) template used for billing statement emails.
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
Custom text field, used to track your affiliates.
Custom text field, used to track your sub-affiliates.
Displays 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.
Bogus Subscription Status: For internal use or test purposes.
Cancelled: The Subscription 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 Subscription is clarified by the current Billing State. Note that the customer who owns the AutoBill object 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.
Dryrun: The Subscription was temporarily created in service of a dry run—it will not be available beyond the duration of the dry run.
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 cancelation. 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 Pending Activation: the Subscription has been completely created but has a future start date. The Subscription is not yet granting entitled service and is not yet billing. The Subscription start date can still be changed.
Unknown: For internal use or test purposes.
Upgraded: A terminal status given to an older version of a Subscription that has been explicitly transitioned using the AutoBill.upgrade() API method.
Legacy Billing Status:
Displays the status of the Subscription.
New: Subscription exists, but has not yet billed the customer
Good Standing: Billing for the current billing period was successful
Stopped: Customer opted out or the Subscription was canceled.
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 Subscription.
Note: The Status field is read-only.
The financial billing condition of a Subscription. 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 Subscription.
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.
Note: This field will not be listed for Subscriptions that contain infinitely repeating Billing Periods in the Billing Plan.
Required. The ISO-4217 three-letter format for the default currency associated with the Subscription.
Note: For a Subscription that is paid using tokens, Currency is displayed as _VT.
Specifies when the Subscription was activated
Specifies when the Subscription becomes inactive.
The day of the month on which the Subscription is set to bill. 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.
The minimum number of Billing Cycles for this Subscription.
Email on Expiration
Sets whether a customer will be notified prior to an expiration date on the Subscription (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.
Note: This field is related to the Email Before Expiration setting in a Billing Plan.
The date through which the customer is entitlement to the products associated with the Subscription.