Products & Product Catalog

Once you've synced your Zuora product catalog, this section will contain a list of all the Zuora rate plans from your Zuora tenant.

The suite product object represents the subscription suite object for representing "subscribable" packages. It’s extending the Zuora product and product rate plan with further configuration options and constraints.

These products can be searched by using the search field in the upper right corner of the page. 1 Zuora rate plan = 1 Suite product. However, the Subscription Suite catalog data model is independent from the Zuora catalog in order to provide additional functionality and to model dependencies between products.

Before rolling out a buy flow to customers, you will want to configure the products first.

Adding a Product

Generally, the standard way to add a new product is to set it up in Zuora and then sync it over into the Subscription Suite. To do that, go to the Sync section of Product Catalog.

You can add custom products directly in the Subscription Suite by supplying the product's name in the Enter a name input field and clicking on Add. Typical use cases for creating a custom product are described here.

Configure a Product

In the Products table click into the row with the product you wish to configure. There are a LOT of configuration possibilities!

Top Section

General Settings

Name

Your product's name - taken over from Zuora. Visible for your customers. If you change it here, it will NOT be updated from Zuora if the rate plan name is changed there.

Product Family

Assign the suite product to a product family. Product Families are can be used to categorize suite products to achieve common behavior like sending the family to a tracking container or implementing customizations based on the product family 

Description

A description for your product. Displayed to your customers if you've enabled it in the Flow configuration.

Feature List

The main features of your product. Please enter one feature per line. Displayed as a bullet list to your customers if you've enabled it in the Flow configuration. Note: these are not Zuora "features".

Highlighted Label

A highlight for a featured product like "Best Choice" or "Bestseller". Should be applied to only one product to not lose its highlight effect.

Product Image URL

The URL to your product's image. The image should not be larger than 150 kB to not increase page load times too much.

Confirm Mode

What happens when customers click on the main button (CTA) of the checkout?

• Subscribe: Customers see prices (also in the shop) and continue to the checkout to create a subscription for this product.
• Request Quote: Customers can't see product prices and have to request a quote. Quotes are generated and accepted in the CPQ module of the Subscription Suite.

Sort Priority

Products are displayed in the order they are created. If you wish to re-order them assign numbers like 1000, 2000, 3000 to them. Leave some (numeric) space to be able to later fit in new products. The higher the number, the closer to the top of the list that product will appear.

Product Type

The product type determines the caption and behavior of the button at the end of product's display card in the shop, and can also be used to implement (for example) a trial checkout or a contact-us form.

• Regular: The regular product which usually wraps one or more rate plans from the connected billing system.
• Contact Sales: This product does not represent any rate plan from the connected billing system but allows to configure a redirect url which should be called when selecting the contact sales option. This can be the page where the contact form is hosted.
• Trial: This product does not represent any rate plan from the connected billing system but allows to configure a redirect URL which should be called when selecting the trial product. This can be the URL of the trial checkout.
• Custom: This product type is used for e.g. place holders in the shop that cannot be selected but serve as a comparison. Mostly used in combination with some customization on keylight's side.

Example shop page

Display Mode

This mode determines how products should be visualized in the shopping cart/checkout. Suite products contain rate plan(s) and rate plans contain Charges, which determine the price of the product. With the Display Mode you can determine how detailed the product information should be displayed. 

• Global Default: 
• Show product only: If this option is chosen, the charges and its prices are aggregated and shown in a compact form. If Charges are unit-based, the quantity picker will change the quantity of all charges at the same time.
• Show charges: If this option is chosen, all Charges that are contained in a product are listed below the product.

• Quantity Level: ⭐ New in Release 2020-06-02
• This applies to Zuora rate plans OR custom suite products which contain multiple charges.
  It determines if the quantity selected by the user applies to all charges in the rate plan or if they should be able to adjust them individually.
  • Product: quantity picker is on the top so that the chosen quantity gets applied to ALL per unit charges. 
  • Charge: quantity picker is on charge level so that the customer can choose the quantity per charge.
• Price Level: ⭐ New in Release 2020-06-02
  • Product: aggregated price is displayed at the product level.
  • Charge: individual charge prices are displayed.

Example of "product" price level:

Subscription Settings

For more information on the effect of these dates see this article in the Zuora knowledge center.

Subscription Type

The type of the subscription that should be generated when purchasing this product. For more information on these Zuora specific options see this Zuora knowledge base article.

Options are:

• Evergreen: This type of subscription has no end date and will run forever.
• Termed: This type has a fixed end date, which can be configured by setting Term and Period Type (days, weeks, months, years). For termed subscription one can also define if the subscription should auto-renew and the subscription type when the subscription is renewed (again Evergreen or Termed - with a RenewalTerm).

Contract Effective Mode

This setting determines how the Contract Effective Date (CED) of the subscription is set.

• Today: will set CED to today. Standard setting for most e-commerce use cases.
• Beginning of next month: will set the CED to 1st of the next month.
• Beginning of next quarter: will set the CED to 1st of the next quarter (calendar months).
• Beginning of next half-year: will set the CED to 1st of the next half-year (e.g. 1st July / 1st January).
• Beginning of next year: will set the CED to 1st of the next year (1st of January).

Service Activation Mode

This setting determines how the Service Activation Date (SAD) of the subscription is set. Certain business cases require this date to be offset compared to the CED. These settings enable this.

• Today: will set SAD to today. Standard setting for most e-commerce use cases.
• Beginning of next month: will set the SAD to 1st of the next month.
• Beginning of next quarter: will set the SAD to 1st of the next quarter (calendar months).
• Beginning of next half-year: will set the SAD to 1st of the next half-year (e.g. 1 July / 1st January).
• Beginning of next year: will set the SAD to 1st of the next year (1st of January).
• Blank: will leave the SAD blank and the subscription will be left in draft mode.

Customer Acceptance Mode

If you need to set the Customer Acceptance Mode.

• Today: will set CAM to today. Standard setting for most e-commerce use cases.
• Beginning of next month: will set the CAM to 1st of the next month.
• Beginning of next quarter: will set the CAM to 1st of the next quarter (calendar months).
• Beginning of next half-year: will set the CAM to 1st of the next half-year (e.g. 1st July / 1st January)
• Beginning of next year: will set the CAM to 1st of the next year (1st of January).
• Blank: will leave the CAM blank and the subscription will be left in draft mode.

Term Start Mode

This setting allows you to align the Term Start Date to one of the following.

• Contract Effective: 
• Service Activation: 
• Customer Acceptance: 

Trigger Date Offsets

Similar to above, it is also possible to configure an offset for all trigger dates. This is useful e.g. for setting up free trial use cases. For more information on free trials see this article in the Zuora knowledge center.

Contract Effective Offset (Days)

• Service Activation Offset (Days):
• Customer Acceptance Offset (Days): 
• Term Start Offset (Days): 

Customer Center Settings

Cancel Mode

This setting allows you to control how and if a customer can cancel their subscription in the customer center.

• Global Default: Set according to global default value.
• Not allowed: this will NOT allow the customer to cancel their subscription in the customer center.
• Effective immediately: this will give the customer the option to cancel effective TODAY.
• End of term or last invoiced period: this will give the customer the option to cancel effective to the end of the subscription term OR the end of the last invoiced period.
• Aligned to specific day
  • Subscription Start Day: this will give the customer the option to cancel and align the cancellation date to the subscription start day.
  • Billing Day: this will give the customer the option to cancel and align the cancellation date to the bill cycle day from the customer account.

Cancellation Period

Supported for evergreen subscriptions and termed subscriptions with auto-renewal.

The cancellation period is the period before the subscription renewal where the customer is not allowed anymore to cancel by the end of term or last invoice period. If the customer wants to cancel within this period, then the end of the next term will be taken as cancellation date.

NOTE: If a customer can have multiple subscriptions with different start days, it is recommended to use the Billing Day: "Charge trigger day" and Billing Period Alignment : "Align to charge" on the Rate Plan Charge configuration to avoid prorations.

Cancellation Period Unit

Specify the unit of measure for the cancellation period. The options are

• Days (default)
• Weeks
• Months

Renewal Mode

This setting determines if the customer can trigger a renewal of their subscription in the customer center.

• Global Default: Set according to global default value.
• Not allowed: The customer is NOT allowed to trigger a renewal in the customer center.
• Allowed: The customer is allowed to trigger a renewal in the customer center.
• Allow Fixed Time Before End: The customer is allowed to trigger a renewal in the customer center X months before the renewal date.

Auto Renew Toggle Mode

This setting determines if the customer can toggle the auto-renew. setting on their subscription in the customer center.

• Global Default: Set according to global default value.
• Not allowed: The customer is NOT allowed to toggle the auto-renew setting.
• Allowed: The customer is allowed to toggle the auto-renew setting in the customer center.

New Subscribe Mode

This setting determines how the product (rate plan) is handled when the customer is subscribing to this product for the first time (new subscribe mode). Specifically, if it is added to a new subscription or added to the subscription of a parent product. For more information on parent products see the documentation here.

• Global Default: Set according to global default value.
• Create new subscription: This creates a net new subscription for this product upon check-out.
• Add to subscription of a parent with same terms: This adds the product to an existing subscription where the terms match.
• Add to subscription of a parent: This adds the product to an existing subscription regardless if the terms match or not.
• Add to subscription of a product with same category and terms: This adds the product to an existing subscription where the terms AND the category match.
• Add to subscription of a product with same category: This adds the product to an existing subscription with the same terms.

Add-on Mode

This setting determines how the product (rate plan) is handled when the customer is subscribing to this product from the add-on section in the customer center.

• Global Default: Set according to global default value.
• Create new subscription: This creates a new subscription for this add-on product upon check-out.
• Add to subscription of a parent if terms are equal: This adds the add-on product to an existing subscription ONLY if the terms match those of the parent product.
• Add to subscription of a parent: This adds the add-on product to an existing subscription regardless of whether the terms match those of the parent product.

Change Options

You may want to allow your customers to make changes to their subscriptions in the customer center. This might be e.g. an upgrade path or just a quantity change.

Upgrade Mode

This setting determines if the customer is allowed to upgrade e.g. from the bronze to the silver plan in the customer center. In order for this to be possible, a change group must be configured first. For more information on change groups see the documentation here.

• Global Default: Set according to global default value.
• Not allowed: The customer is NOT allowed to upgrade in the customer center.
• Effective immediately: The customer is allowed to upgrade and the change is effective immediately.
• End of term or last invoiced period: The customer is allowed to upgrade and the change is effective at the end of term or the last invoiced period.

Downgrade Mode

This setting determines if the customer is allowed to downgrade e.g. from the silver to the bronze plan in the customer center. In order for this to be possible, a change group must be configured first. For more information on change groups see the documentation here.

• Global Default: Set according to global default value.
• Not allowed: The customer is NOT allowed to downgrade in the customer center.
• Effective immediately: The customer is allowed to downgrade and the change is effective immediately.
• End of term or last invoiced period: The customer is allowed to downgrade and the change is effective at the end of term or the last invoiced period.

Quantity Upgrade Mode

This setting determines if the customer is allowed to upgrade (increase) the quantity e.g. from 5 licenses to 10 licenses in the customer center. In order for this to be possible, the product must be a quantity based product in Zuora.

• Global Default: Set according to global default value.
• Not allowed: The customer is NOT allowed to increase the quantity of a product in the customer center.
• Effective immediately: The customer is allowed to increase the quantity of a product and the change is effective immediately.
• End of term or last invoiced period: The customer is allowed to increase the quantity of a product and the change is effective at the end of term or the last invoiced period.

Quantity Downgrade Mode

This setting determines if the customer is allowed to downgrade (decrease) the quantity e.g. from 10 licenses to 5 licenses in the customer center. In order for this to be possible, the product must be a quantity based product in Zuora.

• Global Default: Set according to global default value.
• Not allowed: The customer is NOT allowed to downgrade in the customer center.
• Effective immediately: The customer is allowed to downgrade and the change is effective immediately.
• End of term or last invoiced period: The customer is allowed to downgrade and the change is effective at the end of term or the last invoiced period.

Other

Min Quantity per Purchase

Minimal quantity of a product that needs to be selected during every purchase or quantity change in the customer center. Note that this option does not take previous purchases into account.

Max Quantity per Purchase

Maximal quantity of a product that needs to be selected during every purchase or quantity change in the customer center. Note that this option does not take previous purchases into account.

Purchasable by Customer

• Deprecated

Purchasable by Partner

• Deprecated

Purchasable by Sales

• Deprecated

Hide in Customer Portal

This flag can be used to ensure that a Suite product, when subscribed to it, is not shown in the customer center and on the renewal page. This is used, for example, if a reseller gets an automatic discount on all his purchases and this discount should not be shown in the customer portal.

Hide on Quote Pdf ⭐ New in Release 2020-06-29
This flag can be used to exclude products and their prices from the generated Quote PDF in the Sales Portal.

Click on Save to store your changes.

Rate Plans

If the Suite Product was imported from Zuora through Sync, the corresponding Zuora rate plan is displayed here and is not editable. If you created the Suite Product in the Admin Portal you need to configure one or several rate plan(s) here to create a bundle.

Adding a rate plan

To add a rate plan, just type the name of a Rate Plan into the Search field. Once you see the Rate Plan you're looking for click on Add.

Removing a Rate Plan

In the row of the respective Rate Plan click on the Remove action. The Rate Plan will be removed from this Rate Plans list without further warnings. The Rate Plan itself stays unchanged.

Categories

Product Categories are optional. They help categorize products e.g. "Base Products" and "Add-ons" and create relationships between them. If you wish to use them you first need to define them in the Categories section.

Adding a Category

Type the name of a Category into the Search field. Once you see the Category you're looking for, click on Add. Categories are created on the Categories page of Product Catalog.

Removing a Category

In the row of the respective Category click on the Remove action. The Category will be removed from this categories list without further warnings. The Category itself stays unchanged.

Customer Center Add-ons

Adding a Customer Center Add-on 

If you want the customer to have the ability to purchase add-ons from the customer center, this can be configured here.

To add an add-on rate plan, just type the name of a Rate Plan into the Search field. Once you see the Rate Plan you're looking for, click on Add.

These will then appear in the customer center below the main product.

Removing a Customer Center Add-on

In the row of the respective Customer Center Add-on, click on the Remove action. The Customer Center Add-on will be removed from this Customer Center Add-on list without further warnings. The Customer Center Add-on itself stays unchanged.