Tiers

This guide will detail the expected flows and endpoints for implementing tiers using Headless API.

See our Creator docs for Tiered Packages to learn how to set up tiers.

If you are using an older or custom store template, you may need to modify your template to support tiers. A tiered category view is different from a non-tiered category.

See Supporting Tiers on Custom Store Templates to learn how to set up the necessary pages.

Checkout Flow

Tiers require an authenticated user. After you create the basket, you must log the user in using the relevant basket auth links.

See Creating A Basket for further information.

The expected flow for checking out with a Tier is identical to any other package:

1. Create the basket

2. Authenticate the user via the basket's auth links

3. Add the tiered package to the basket

4. Direct the user to checkout

On successful checkout, the user will now have an active_tier when retrieving their tiered categories against their usernameId.

If the active_tier property is not present, the user does not have an active package in that tier.

API Endpoints

Tiered categories use our existing /categories endpoint.

Unlike other Headless API endpoints, you must use HTTP Basic authentication with the Username set to your Public Token and Password as your Private Key. See Authorization for more information.

All tiered categories will have the property tiered: true