Zephr User Guide

Creating and Managing Zephr Products

243 views 0

In Zephr, a Product is a way of grouping features together into one package and is used to provide your customers with access to your content.

Products can be monetised using third party payment providers, with Zephr out-of-the-box payment forms available to build quick and easy paywalls.

Before creating a Product, we recommend you configuring a corresponding plan or subscription within your chosen payment provider.

Creating and Managing a Product

To create a Product, navigate to Products > Catalogue, and select Add A Product.

Adding a Product - Add Product Screen

Give your Product a Title, and optional Description.

Select Features

Specify the Features the Product is relevant to. This is so when users access the Features selected, and have the Product granted to them, they will be considered Customers, and follow the Customer user journey created within that Feature rule.

If you need to create a new feature, click the Add a Feature button, given your Feature a Title and Description, then select the Type of Integration and click Save.

Creating Products - Add a Feature

If the Feature already exists, selecting it from the list of available Features.

Adding a Product - Selecting Features

If the Feature is available across multiple sites, you can choose to limit the Product to be available on specific sites. To do this, click the Add Sites & Site Groups button, and select the relevant sites.

Adding a Product - Specifying Sites

Payment Options

To add Payment Options for your Product, you will need to link Zephr to a payment provider. Zephr integrates out-of-the-box with Braintree, Stripe and Chargify.

If you haven’t done this yet, read our Payments guide. If you’ve set this up already, continue reading.

Payment Options determine the way your users can pay to gain access to the Product. For example, an Article Subscription may offer a plan to gain access for £10 for one month, or a plan to gain access for £5 per month, for 12 months. If you are using Stripe, your payment plan may also vary in price each month. Read the ‘Scheduled Payment Plan’ section below for more details.

First, select Add a Payment Option.

Regular Plans

In most cases, the ‘Type of Plan’ you select will be set to ‘Regular’. A Regular plan is available when you are integrating with Braintree, Stripe, or Chargify.

This allows you to find payment plans already set up within your payment provider, who will manage the subscription on your behalf and charge the user as needed.

Enter the name of the payment plan, as it has been set up within your payment provider, or click Browse Payment Plans to find it in a list of payment plans you have configured within your payment provider.

Products - Select Payment Option

Once you have selected the Payment Plan, you will see more information regarding the plan details. Most of these – the Plan Name, Product Price and Billing Period – cannot be edited, as they are pulled directly from your payment provider.

You will, however, have the opportunity to edit the Billing Cycles. Here you have two options:

Recurring Billing Cycles will continue to charge the user for as long as the Payment Plan states within your payment provider settings. For example, if you have a Braintree Payment Plan set up to bill perpetually, or for 12 consecutive months, payments will follow this plan.

Custom Billing Cycles allow you to override the number of billing cycles set within your payment provider. For example, a Braintree Payment Plan may be set to bill perpetually, but you could override this in Zephr to end after three billing cycles.

Payments - Recurring Payment Billing Cycles

Once you have set your Billing Cycles, click Add.

Your Payment Options will display below the Add A Payment Option button, with details of the Plan Title, Cost, Currency, Billing Period and number of Billing Cycles. Clicking the kebab menu will allow you to either edit or delete the payment option.

Payments - Viewing Payment Options

Scheduled Payment Plans

If you are using Stripe, you will also have the option to select a Scheduled Payment Plan.

Scheduled Payment Plans allow you to create a payment plan with staggered pricing. For example, offering a one-year subscription for £10 per month for the first three months, after which the customer will pay £20 per month for the remaining nine months of their term.

Creating a Scheduled Payment Plan is similar to the way you create a Regular Plan.

Start by selecting the Scheduled Payment Plan option under the Type of Plan heading and give your Scheduled Payment Plan a title.

Following this, select the first relevant plan from your list of linked plans. This should be the plan with the pricing relevant to the first part of the schedule.

Products - Scheduled Payment Plan - First Payment

In the image above, you’ll note we selected Plan 4 – a plan charging users £10 per month. By setting the Custom Billing Cycles to 3, we ensure the user is charged £10 per month, for the first three months.

Next, click Add To Schedule. Repeat this process with the other Payment Options you wish to include in your Scheduled Payment Plan.

You’ll note that once each payment option is added, they will appear in the Subscription Schedule below. This details the Plan Name, Price, Currency, Billing Frequency, and the number of Billing Cycles. You can drag and drop Payment Options within the Subscription Schedule to reorder them.

Products - Scheduled Payment Plan - Second Payment

In the example above, customers using this Scheduled Payment Plan will be charged £10 per month for the first three months, followed by £20 per month for the remaining nine months.

Scheduled Payment Plans can also include Recurring Billing Cycles, where a user is charged until the end of the payment cycle set by your payment provider, however, this option must be placed at the end of your Subscription Schedule.

Once your payment options are in place, click Add.

Your Payment Options will display below the Add A Payment Option button, with details of the Plan Title, Cost, Currency, Billing Period and number of Billing Cycles.

Products - Payment Options - Scheduled Payment Plan View

Clicking the kebab menu will allow you to either edit or delete the payment option.

Developer Interface

At the bottom of a Product page, you will see a Developer Interface. This section is used for more technical product integration, such as sharing information from a third party subscription management platform via JSON Web Tokens (JWT).

We recommend that any changes made in the developer interface are done with or by a developer, so when you click into this section, you’ll need to confirm you wish to edit the section.

To integrate products using a JWT, you’ll need to enable JWT syncing. Find out how to do this in our JSON Web Token (JWT) guide.

Once set up, select ‘Auto-assign from JWT’, once selected, you will need to add a Claim Value. Set this value to the value your IDM will put into the JWT payload if a user has the product (note that arrays and string values are supported in the payload). Click Update & Lock.

JSON Web Tokens - Product Syncing

When the JWT syncing for a product is set up, any bearer with a JWT payload that asserts they hold a product will inherit the mapped product.

In the example JWT payload below, the user has ‘subscription-1’. Based on this payload matching the claim name used in our Article Access Product above, the user would then be granted the Article Access Product, and get access to the relevant Features accordingly:

“sub”: [“subscription-1”],
“city”: “NY”