Docs / Using the plugin / Filters
Filters
Narrow the report to the records you need with the Filters picker, and add, edit or remove filters.
After this page, you will be able to apply, change and clear filters, choose which data a filter reads, and add filters of your own.
How filters work
The Filters picker sits above the table. When nothing is applied it reads All subscriptions, All memberships or All subscriptions and memberships. Once you apply filters, it shows how many are applied.
Values you pick in the panel only take effect when you select Apply filters.
Default filters
Filter | Type | Notes |
|---|---|---|
Product | Searchable list | Needs Subscriptions |
Coupon | Searchable list | Needs Subscriptions |
Date range | Date range | Starts on the subscription Start date |
Status | Tick list | Starts on subscription statuses |
Payment method | Tick list | Lists stored gateways, or your enabled gateways if none are stored yet |
On a Memberships-only store, Product and Coupon are not shown. Plan is not a default on any store. Add it with More filter.
Apply a filter
Before you start
- You are on the Reports tab. See The Reports tab.
Steps
- Select the Filters box above the table.
- Select a filter name, for example Status, to open it.
- Tick the values you want. Searchable lists have a search box at the top.
- Open more filters and pick values the same way.
- Select Apply filters.
What you should see
- The table shows only matching records.
- An Active filters list appears under the picker, for example “Active filters (2)”.
- The Summary panel appears with totals for the matching records.
Ticked values in different filters must all match. Ticked values inside one tick list are alternatives. For example, Status Active and On hold shows records in either status.
Change or clear filters
Where | Control | What it does |
|---|---|---|
Active filters list | Edit | Opens the Filters panel |
Active filters list | Remove | Clears that one filter’s values |
Active filters list | Clear all filters | Clears every filter’s values |
Filters panel, header | Clear all | Clears every value in the panel |
Filters panel, filter row | Reset icon | Clears that one filter’s values |
Filters panel, filter row | Pencil icon | Opens Edit filter field |
Filters panel, filter row | Trash icon | Takes the filter off the list |
Filters panel, footer | Reset | Puts back the default filter list |
The icons on a filter row show when you hover over or tab to the row. Default filters can be edited and removed like any other.
Choose subscription, membership or order data
Some filters can read more than one kind of data.
Status
When you open Status, a Status source toggle shows Subscription, Membership and Order (only for active plugins). The status list changes to match. Order filters on the status of the orders tied to each subscription or membership.
On a store with both plugins, you can also set this in Edit filter field with the Dependency dropdown.
Date range
When you open Date range, a Date source toggle shows Subscription, Membership and Order (only for active plugins).
- Pick the Date source.
- If that source has more than one date, pick it in Date field.
- Pick the dates.
For Order, the dates are the related order date. You can pick a preset first: Last week, Last month, Half month, Year, Last year or Custom. For Subscription and Membership, you go straight to Start date and End date.
Preset | Dates covered |
|---|---|
Last week | The last 7 days, including today |
Last month | The whole previous calendar month |
Half month | The 1st to 15th, or the 16th to today, of this month |
Year | 1 January to today |
Last year | The whole previous calendar year |
Custom | The start and end dates you pick |
Dates you can filter on
Date source | Date field | Needs |
|---|---|---|
Subscription | Start date (default), Next payment, End date, Last order, Trial end, Cancelled date, Payment retry, Last modified, Created, Parent order date | Subscriptions |
Membership | Member since, Expires, Membership cancelled, Membership paused, Membership created | Memberships |
Membership | Membership trial end | Both plugins |
Order | Order date | Either plugin |
Membership dates also work on subscription rows. They read the membership tied to each subscription.
Add a filter
- Open the Filters panel and select More filter. The Add filter field dialog opens.
- Pick a source on the left. You see one tab per field group, such as Subscription, Membership, Customer, Order and Address. There are also tabs for Subscription meta, Membership meta and Order meta.
- Type in Search fields to find a field, then select it.
- Change Filter name if you like.
- Pick a Control: Multi-select, Single select, Date range, Number range, Text contains or Yes / No.
- Select Add filter. The filter joins the panel list.
- Pick values and select Apply filters.
The dialog only lists fields from active plugins. Fields already on the list are left out. Picking a date field binds the Date range filter to that date.
Other filters you can add include Plan, Billing country, Shipping country, Billing state, Shipping state, Manual renewal, Billing period and Membership type. See Filter reference for the full list.
For filters on custom data, see Custom field columns and filters. For membership profile fields, see Profile fields.
Edit a filter
- Open the Filters panel.
- Hover over the filter row and select the pencil icon. Edit filter field opens.
- Change the field, Filter name or Control.
- Select Save.
Number ranges and text
- Number range shows Min and Max boxes, with your currency symbol when one applies.
- Text contains shows one box. Records match when the field contains your text.
What is saved
Your filter list, names and data source choices are saved in your browser, per site and per user. They do not follow you to another browser or computer. The values you apply are not kept when you reload the page.
Customer, order and address filters
These filters read the record of the first ID column in your table. With S ID first, they read the subscription. If you remove S ID so M ID comes first, they read the member’s customer profile and the membership’s order. See Columns.