| Start Date | The first day of the specified date range, if the Subscription was active for the Account on that date. Otherwise, the Start Date will be the date the Subscription was activated within that date range. |
| End Date | The last day of the specified date range if the Subscription was active on that date. Otherwise, the end date will be the date that the Subscription stopped being active within that date range. |
| # of Days (also known as Number of Days) | The total number of days that this Subscription was active within the specified date range. |
| Account VID | A globally unique identifier that is created by Commerce Engine when you create an Account in the Commerce Engine database. |
| Account ID | Reseller-defined Account identifier. |
| Autobill ID (also known as Subscription ID) | The unique identifier that describes the terms of a customer’s recurring payments to a product or service. |
| Autobill Status (Deprecated) (also known as Legacy Subscription Status) | Status for a legacy Subscription. Values include: - New - Good Standing - Soft Error - Hard Error - Deferred - Stopped - Pending - Upgraded - PendingCustomerAction Note: This field represents the Subscription’s Billing Status. |
| Autobill Status (also known as Subscription Status) | The current Status for the Subscription. Values include: - 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, Reseller (Service Provider), or system action—for example, the customer has opted out of recurring billing or canceled the service; or API calls to cancel the subscription or stop billing on the Customer have been made. 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. |
| Product ID | The Product identifier from the Subscription or Stock Keeping Unit (SKU) specified in the Transaction. |
| BillingPlan ID | Billing plan identifier. |
| Reseller Affiliate | A free-form string (if any) for the Reseller (Service Provider) affiliate who submitted the specified Subscription object. |
| Autobill Billing State (also known as Subscription Billing Date) | Administrative state of a Subscription. The billingState field contains the following values: - 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. - Pending Acceptance: The Subscription uses a payment method that requires Reseller (Service Provider) 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 Reseller (Service Provider) action. No further billing is planned. - Grace Period: The Subscription 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. |
| Parent topic:Subscription Reports | |
