Filtering Subscriptions in Subscribe

The filters allow you to search for a list of subscriptions you seek by filtering out unwanted results.

Pages associated with the billing menu typically include large volume of results. This is why they do not display results by default when you initially access them. Instead, the filtering screen lets you search for the required records. The search results appear for the page throughout the session.

Subscription Filtering Considerations

Use the following guidance and considerations to improve filtering performance:

An exact match search of the the following fields is run first in the order shown. If the input provides an exact match to an account result it is immediately displayed and all other fields are ignored.
1. ID
2. Customer ID
3. Subscription Name
When filtering by multiple fields such as Customer Email and Created Date Between, the displayed results match both the email AND the dates you entered. Fields in which you type a value, filter for that value. A search for customer Pete Johnson, for example, will not return results for Peter Johnson. A search for customer Pete, will display results for Peter Johnson.
The filtering screen includes key search fields, displayed with a light blue background for specific fields. At least one key search field (with a blue background) must be used in order to search.
When filtering by the date range key field only, the search is limited to 90 days. When using multiple filtering input, the date range is unlimited.
Up to 50,000 results will be displayed per search.

Subscription Filters


Field	Previous Naming (Portal 1.0)	Guidance	Relevancy
ID	AutoBill ID	Your unique identifier for the subscription. Note: If an exact match is found for this field, it is immediately displayed	Key field, at least one is required to filter.
Customer ID	Customer ID	Also known as Account ID or Merchant Customer ID. This is your unique identifier for a customer. The ID is a string of up to 1024 bytes with digits, characters and special symbols support. Note: If an exact match is found for this field, it is immediately displayed	Key field, at least one is required to filter.
Customer Name	Customer Name	Customer’s full name—typically corresponds to the name associated with the payment method on the account.	Optional
Customer Email	Customer Email	Enter the Email address of the customer account (associated with the subscription) in the typical format XXXX@example.com	Optional
Subscription Name	Rebill Name, AutoBill Name	The Name defined for the Subscription. Note: If an exact match is found for this field, it is immediately displayed	Key field, at least one is required to filter.
Status	N/A	Select the status of the relevant subscription you're seeking. Select from: 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.	Optional
Payment Method Type	Payment Method Type	Select the relevant payment method from the dropdown list. For a list of supported payment methods, see Account Payment Methods Pane.	Optional
Billing State	N/A	Select the relevant Billing state for the subscription you are seeking. Select from: 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.	Optional
Currency	N/A	Select the relevant Currency for the subscription you are seeking.	Optional
Created Date Between	Created Date Range	Define the date range during which the subscription was created. When filtering by the this field only, the search is limited to 90 days. When using multiple filtering input (regardless if key fields), the date range is unlimited. Use the Calendar picker to select your date range, or enter dates directly in the fields.	Key field, at least one is required to filter.

How to Filter

To filter the page, do the following:

Enter the relevant value by which you'd like to search in the key fields (blue background). You can also search by additional fields. Refer to the tables for guidance regarding the filter fields.
Click Apply to filter the results.
A list of the results appears. If there is only one result, the details page opens immediately.
To change the filter query, click Change Query and enter the relevant values.
To clear your filter parameters, click Clear.