Welcome to Zuora Product Documentation

Explore our rich library of product information

Product catalog deployment guide

Learn about Zuora Billing product catalog that offers a flexible interface for managing products and pricing, tailored for subscription businesses, and supports deployment through Deployment Manager.

Zuora Billing product catalog helps you define your products and pricing. Every company has a product catalog that lists the product details and pricing. Designed specifically with subscription businesses in mind, the Zuora Billing Product Catalog has a flexible interface that makes it easy to create new products and rate plans or modify existing rate plans on the fly. The product catalog's ability to handle sophisticated pricing models gives you the power to easily adapt your pricing to customer and market needs in order to grow your business and drive more revenue. For more information, see Product Catalog.

Deployment Manager supports product catalog to provide users with a one-stop approach for deploying configurations. This enables you to create products in the target tenant or deploy delta changes from the source to the target tenant.

Product catalog deployment functional flow

Product catalog deployment is a synchronous and asynchronous process, the functional flow is as follows:

Deployment Manager Product Catalog functional flow

Product deployment high-level activities

  1. Create a source tenant

    To run a deployment, you need to create a source tenant that hosts the metadata objects you want to migrate to other tenants. There are two ways to create a source tenant:

    • From the Source Tenants tab on the landing screen of the Deployment Manager.

    • When a new deployment run is created. See Run a deployment.

  2. Run a deployment

  3. (Optional) Revert a deployment

Run a deployment

Deployment is the process of migrating product catalog as a component from a source tenant to a target tenant.

To run a deployment after you have logged into the target tenant, click Deployment Run, then click the +New button.

You can filter the product catalog records by selecting the following options during the deployment run.

  • Primary comparison keys : Product Name and SKU

    • If you select Product Name, the records on the compare screen are filtered and displayed with the name of the products. The system will treat all the products with the same name as duplicated and does not display them on the compare screen for deployment.

    • If you select SKU and Product Number, the records are filtered and displayed. Products with same name are not skipped using this option.

  • All Products - Includes all the active and inactive products, including base, add-on, and miscellaneous.

  • Active Products - If you select this option, all the products currently tagged as Active in the source tenant will be displayed. The inactive products are not displayed.

  • Rate Plans - When you have made the product level selections, you can select the rate plans.

Primary comparison keys and availability

  • Product: Name or SKU or Product Number

  • Rate Plans: Name of the Rate Plan

  • Rate Plan Charges: Name and Charge Type of the Rate Plan Charge

  • Rate Plan Charge Tier: Tier

Revert a deployment

After a deployment run is complete, you have the choice to revert the values of the target tenant to their previous values.

To revert a deployment run, click Revert under the Action column in the Deployment Run tab.

Upon revert, the status of the deployment run will be changed to Reverted. The job status is reflected under the Status of the Deployment List view page.

Note: You can revert a deployment only if its status is Done.

Deploying features, products, and bundles

Use Catalog (New) to deploy new product catalog components and capabilities. To access these components, from the Deployment Manager Select screen, select Product Catalog and select Catalog (New).

The following component types are supported:

  • Features

  • Products

  • Bundles

Deployment Order

To ensure a successful deployment, deploy components in the following order:

  1. Features

  2. Products

  3. Bundles

Note: Deploy features before deploying products or bundles. Deploy products before deploying bundles.

This deployment sequence ensures that all dependent components are available in the target tenant and helps prevent deployment validation failures.

Recommendations for deploying features, products, and bundles

Note: Deployment Manager will support bundle deployment in a future release.
  • Deployment Manager supports a maximum of 3,000 products. Product retrieval is limited to the first 3,000 products combined from the source and target tenants.

    Note: Deployment Manager compares the first 3,000 products in the source tenant and displays those that match products in the target tenant on the Compare screen.
  • For products containing 300 or fewer rate plans and charges, all product data is available for deployment.

  • For products containing more than 300 charges, only the first 300 charges are available.

  • Product catalog sharing is not supported in Multi-Entity environments when using the new product catalog.

  • Zuora recommends deploying tax codes, accounting codes, revenue recognition codes, currencies, and custom fields before deploying product catalog components. For New Commerce, also deploy taxes, contexts, and attributes before deploying product catalog components.

  • Use unique product names and standardized SKU or product-number prefixes to simplify deployment and maintenance.

For more information, see Product catalog deployment best practices.