Zephr User Guide

Creating and Managing Zephr Products

90 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.

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 your Braintree or Stripe account. If you haven’t done this yet, read our Payments guide. If you’ve set this up already, continue reading.

Payment Options determines the way your users can pay to gain access to the Product. For example, an Article Subscription may offer a one-off payment option of £10, or a recurring payment option of £1 per week.

First, select Add a Payment Option, then choose between a One Off Payment or a Recurring Payment.

One-Off Payments

One-Off Payments allow you to name the payment option and set the price users will pay for it. Simply label your pricing option, and set the price point under the Price heading. Note, this price will be set to the currency provided by your payment provider.

Adding a Product - One Off Payments

Recurring Payments

Recurring Payments is used 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.

This section is linked directly with your payment provider. 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.

Adding a Product - Recurring Payments

Once you have selected the Recurring Payment Plan, a modal will open displaying 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

Note: Zephr integrates with Braintree and Stripe as out-of-the-box payment providers. If you have not linked your accounts together yet, we suggest you read our Payments guide before creating products.

Once your payment options are in place, click Save.

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”
}