Skip to main content

Configure Portal Features


Configure Portal Features

After you have configured the user interface of the portal, you are ready to configure the data and features for your portal. 

  1. In the Setup page of your Ecommerce Portal instance, click the CONFIGURATION tab.
  2. Complete the information in the Domain Information section.
    1. The Customer Portal URL displays the URL of the portal login page. You need to submit a ticket at Zuora Global Support to change the system-assigned portal URL to a domain owned by your company.
      By default, the portal URL is in the format of
       You can change it to something like the following URL:
    2. Select a default route from the Set Default Route dropdown list. The default route identifies the landing page which end users will be directed to when accessing the portal. The available routes upon installation are:
      • login - Direct end users to the login page of the portal. 
      • products - Direct end users to the products page of the portal. The products page displays all products in the Customer Catalog. This route is only available if you are using the Subscriber Portal with the Subscription Management feature enabled.
  3. In the Cutover Date section, set the effective date for all viewable customer information. The cutover date filters the transactional data and prevents the data before this date from being viewed in the portal. For example, the cutover date is useful when migrating from one portal or system to the Subscriber Portal. It prevents the legacy data used for the catch-up bill run migration from being displayed. 

    The system will pull the transaction data after the cutover date (exclusive of the cutover date). For example, if you would like to show all data after September 1, 2019, you should enter 2019 August 31 for the cutover date.

  4. In the Filter information section, you can customize your own filters to locate the desired resource.
    Note: The REST APIs for Usage, Debit Memo, and Credit Memo do not support filters, so the statement is currently evaluated as a string. This means the filter conditions like dates and numbers cannot work as expected for these objects apart from the = comparison.
    Custom filters
  5. Configure the Payment Page details in the portal. You must ensure that you have created a Payment Page in your Zuora tenant. See Create a Hosted Payment Page in Zuora for more information on how to create a payment page in your Zuora tenant. Note that when creating a new Payment Page in Zuora, you must complete the Basic Information pane as follows:
    • In the Hosted Domain field, enter the Customer Portal URL displayed in Configuration tab.
    • Enter /dashboard in the Callback Path field.
       Zuora Payment Page Basic Information Configuration

    After a Payment Page in Zuora is created, complete the following fields based on the Payment Page configuration:

    • Type - The payment method type that will be captured by the payment page.
    • Name - The name displayed to end users to describe the type of payment methods.
    • Payment Page Id - The ID provided by the corresponding Hosted Payment Page configured in Zuora. In order to obtain the Payment Page Id, navigate to Settings > Payments > Setup Hosted Pages > Actions > Show Page ID in your Zuora tenant.

    Click + Add new payment page to add additional payment pages if you have more than one Payment Page.

  6. (Optional) Enter the Promo Code URL and Promo Code API Token of your Promo Codes app instance in the Promo Code Settings section. Promo Codes is a separate app that you can purchase in Zuora Marketplace, and is not required for the Subscriber Portal's use. 
  7. in the Payment Constraints section, enter the minimum and maximum amounts of payments that will be accepted via the portal. The default amount is dependent on the selected currency in Zuora environment. 
  8. In the Tenant Information section, complete the configurations.
    1. Select the time zone associated with your Zuora tenant. Aligning the portal time zone with your Zuora tenant time zone can avoid errors when making payments. 
    2. Enable Zuora Orders if your tenant uses the Zuora Orders feature. Zuora Orders must be enabled if you are using the Subscription Management feature of the portal.
    3. Enable Zuora Invoice Settlement. You must select this check box if this feature is enabled in your Zuora tenant in order to ensure the product operates as intended. 
    4. Enable Credit And Debit Memos if your solution uses credit and debit memos and you want to expose credit and debit memos to end users.
  9. In the Feature Configuration section, enable the features for the portal .
    • User Roles - This feature enables you to restrict the accessibility of the portal to certain Zuora contacts. To restrict the accessibility of the portal, you must create a custom field on the Contact object called KongRole with one of the following values in your Zuora tenant:

      A contact can be associated with multiple accounts. If a contact is whitelisted in one account and blacklisted in another, he can view the details of the account with the whitelist role setting, but cannot view the details of the account with the blacklist role setting.

      This feature is an Admin Option and is not enabled by default. Submit a request at Zuora Global Support to enable this feature.

      • whitelist - Allows a contact to view all information and perform all functions in the portal.
      • blacklist - Prevents a contact from viewing the information of this account in the portal.
    • Shopping - This feature enables you to acquire customers through an Ecommerce shopping experience. If the Enable check box is not available to you, contact your sales associate for instructions on how to enable this feature.
    • Usage Screen - This feature enables a Usage page in the portal that displays Usage data.
  10. In the Configure Your Custom Endpoints section, add in a query in Zuora Object Query Language (ZOQL) to obtain the information to be displayed in the portal. See ZOQL for more information.
  11. In the Field Display Configuration section, configure the fields that will be viewed and edited by end users in the portal.
    1. Click Account Fields, Contact Fields, or Usage Fields.
    2. Select the check box for the desired fields. 
      • For Account Fields and Contact Fields: You can optionally enter the custom name for each field. Note that any edit completed by end subscribers will be displayed within their account or contact information stored in your Zuora tenant.
      • For Usage Fields: The following default Usage fields and any other Usage field configured in your Zuora tenant will be viewed by end users: Subscription Number, Submission Date Time, Unit of Measure, Start Date Time, and Quantity.
    3. Click Done to save the configuration. 
  12. In the Password Strength section, select the password strength requirements for end users in the dropdown list. 
    Password strength is applied when the portal users create or reset portal passwords. You can also create a custom password strength by entering a Regex expression. For example, to ensure a special character is included, enter a Regex expression such as (?=.*[!@#\$%\^&\*]).
    This setting is not available in the admin portal for solutions using SSO.
  13. In the Configure Your Translations text box, provide user-friendly translations of the pre-defined identifiers in Zuora. The default translation is automatically populated and available for editing.
  14. Select the default language for the portal in the Pick Default Language dropdown list. Note that this setting will change the language for only the portal instead of your Zuora tenant. 
  15. Click Save Settings to save the configuration.

What's Next

Now you are ready to work with Subscriber Portal.