Filter Plans in Checkout by Contract Term or Other Criteria

Overview

Checkout filters let you group plans on the internet plan screen by a category you define, such as contract length or download speed, so customers aren't shown every plan variation at once. In this article, we'll cover how filters work and how to create one using product specification fields.

Understand how checkout filters work

If you offer plans with the same speed but different contract terms (for example, 12-, 24-, and 36-month options), listing each one separately on the plan screen quickly becomes unwieldy. Filters solve this by letting customers narrow the plan list to the option that applies to them.

• Filters are agnostic to category — you can build them around contract length, download speed, or any other product attribute.
• Filters appear on the internet, router, mobile, phone, and TV plan screens in checkout. They aren't available for add-ons or the Featured Bundles step.
• Filter categories are independent between product categories, so you can, for example, offer a 3-year internet contract alongside a 1-year mobile contract without conflict.

Create a filter using product specification fields

Setting up a filter has two parts: add the filterCategories spec field once at the product category level, then assign a filter value to each product you want included.

Each filter option corresponds to a separate product, so you'll need a distinct product or product version for every value you want customers to be able to filter by. For example, offering 12-, 24-, and 36-month terms on the same 1-Gig plan requires three separate products.

1. Identify the product category you want to apply the filter to by going to Products > Settings > Categories, then selecting the relevant category.
2. In Category Details, click Edit.
3. Under Specs, add a spec field named filterCategories and set its type to an array of strings.
4. Go to your product catalog and open the product you want to assign a filter value to.

5. Under product details, scroll down to the specification fields and locate the filterCategories field.

   Because it's a string array, it can take any number of values, so a single plan can appear under multiple filters.

6. Enter the title you want displayed on the filter for that product, such as "12 months" or "36 months".
7. Click Save.

Repeat steps 4–7 for each product you want included in the filter. Once saved, the filter appears automatically in checkout — no additional configuration is required.

Review how filters behave in checkout

• If a screen has filters, any product with no filter value assigned appears under every filter shown on that screen.
• If only one filter value is available at a given address, gaiia won't display filter chips at all.
• When two or more filter values are available, filters are sorted alphabetically, left to right.