Welcome to Zuora Product Documentation

Explore our rich library of product information

Subscriber portal overview

The Subscriber Portal is a web solution by Zuora that allows access to billing and transactional data, offering customization options for portal instances.

Subscriber Portal is a web portal solution provided and hosted by Zuora. It not only provides a means to quickly access your customers' billing and transactional data created in Zuora, but also enables you to customize portal instances based on your preferences.

The following diagram illustrates how a Subscriber Portal works:

Subscriber portal architecture

1. End subscribers can access the configured portals through the Web on any device. The portal does not provide a mobile app but is responsive to resize based on the device. A customer can access various portal instances that are customized for different customers. The portal comes standard with a number of pages and gives you the flexibility to create custom pages using JavaScript, HTML, and Vue.js.

2. Currently, you must use the Subscriber Portal user interface to access the relevant data in Zuora.

3. The Subscriber Portal has its own set of APIs. It pulls data from different sources and returns to corresponding callers. These APIs simplify the calls to downstream systems (for example, Zuora) by wrapping multiple APIs into a single call.

4. When the data is created in Zuora, it immediately becomes available in the portal. If the transactional data is created through the Subscriber Portal, it will be pushed directly into Zuora instead of being stored in the portal. Note that in some cases, if the data is entered directly in the portal, you need to refresh the portal page to view the data.

The examples of Zuora objects where the data is stored include:

  • Product Catalog

  • Invoices

  • Taxes

  • Payments

  • Refunds

  • Contacts

  • Subscriptions

  • Usage

5. The Subscriber Portal maintains PCI compliance by using Zuora's Hosted Payment Method Pages (HPM) to accept credit card data. Credit card forms are presented via the HPM iFrame, and the entered data is directly pushed back into Zuora. No credit card data is stored in the Subscriber Portal.

The support for HPM in Subscriber Portal makes the process of integrating HPM easier, but less customization flexibility is offered. For example, customizing error messages for HPM is not supported in Subscriber Portal.

6. The Subscriber Portal stores only the portal-specific information instead of the transactional data. An example of the data stored in the portal is:

  • Portal Audit Trail - The log that records which pages are visited and what actions are carried out in the portal.

  • Portal Settings - The settings that impact features, data, and the flow in the portal.

  • Portal Users - The portal users who are mapped to one or more Contacts in Zuora or linked to external users via SSO.

  • Customer Catalog - The portal synchronizes with the Zuora Product Catalog and creates a local version called Customer Catalog. It will be used during shopping in the portal.

  • Promo Codes - The coupons and offers that leverage Zuora discount plans.

7. The portal calls out to external APIs and retrieves data. The data will be displayed in the configured custom panels.