Zuora Release 2022.11.R2
Welcome to the release notes for Zuora Release 2022.11.R2. This article is a consolidated page of all release notes for the following Zuora products:
For the latest release notes of Zuora Revenue, see Zuora Revenue release notes.
We welcome and appreciate your feedback on this release notes article. Please use the Feedback button to let us know what you think about the new release notes.
Release schedule
For release schedule details, see this release notification.
For the planned schedule of upcoming Zuora releases, see Zuora Release Management in Zuora Community.
Join Release Notifications in Zuora Community to receive timely notifications about Zuora Billing, Collect, and Central Platform.
UI enhancements
Redesigned error pages
To improve the user experience with the new Zuora UI, the error pages displayed in the following scenarios are redesigned to provide clear explanations about what goes wrong and what action can be taken to resolve the error:
- The custom object is not found
- The feature is not enabled
- The page is not found
- Internal server error occurs
- The query timeout period has exceeded
- The user access is denied
Restyled Reporting pages (sandbox only)
Most UI pages of Zuora products have been redesigned to adopt a new style since one year ago. The new UI style provides a modern look and feel when you are interacting with the product UI. From this release, we are pleased to announce that Zuora Reporting pages have also adopted this new UI style. This new style mainly involves updates to fonts and colors and does not introduce any functionality changes.
Note that the restyled Zuora Reporting pages will be deployed only to all Sandbox environments in this release. They will not be deployed to Production environments until further notice.
Zuora Billing
Reinvented invoice details page available in Production
From this release, the reinvented invoice details page is introduced to the Zuora UI in Production environments with the following highlights:
- Multi-section page with a new look and feel for efficiency to use
- Existing functions in the previous UI smoothly retained
We will be gradually releasing the invoice details page to all Production tenants where the Invoice-Level Rounding feature is disabled.
To enable or disable the reinvented invoice details page for individual users, go to the user profile to edit the Enable New Zuora Experience setting. Note that if you disable the New Zuora Experience, the reinvented list views will also be disabled. To disable the reinvented invoice details page across all users within a tenant, contact Zuora Global Support.
Support for hiding zero-amount invoice items on reinvented invoice details page
With the new user interface, you can now hide zero-amount invoice items on the reinvented invoice details page. When you have usage-based invoices and most usage charges are zero amount, this feature can help you find non-zero charges efficiently.
This feature is only available if you have the Enable New Zuora Experience setting enabled. For more information, see New user interface.
Zuora Collect
Payments
Auto-enablement of Token Expiration for hosted payment pages
To better protect your hosted payment pages within our service from card testing attacks, on 8 November 2022 PDT, we automatically enabled the Token Expiration feature on all production tenants that have not yet implemented this anti-fraud measure. The Limit the number of submissions before blocking submission field is set to a default value if the current value is out of the range of 1 - 10. If your current value is 0, after the auto-enablement, you must implement a token refresh function in your code to handle the token expiration scenario.
This change went live on sandbox tenants on 3 November 2022.
For more information about the Token Expiration feature, see Security measures for Payment Pages 2.0. For the sample code of implementation and exception handling for this auto-enablement, see nodejs-express based sample code suite.
Deprecation of Google reCAPTCHA v2 Classic for hosted payment pages
On 8 November 2022 PDT, we deprecated the support for Google reCAPTCHA v2 Classic for hosted payment pages from production tenants. This change went live on sandbox tenants on 3 November 2022.
We highly recommend that you migrate to reCAPTCHA Enterprise by following this migration guide. If reCAPTCHA Enterprise is not enabled on your production tenant before 8 November 2022, the reCAPTCHA service will be disabled on your tenant on 8 November 2022. Though you can still enable reCAPTCHA Enterprise later, your tenant will not be protected by the reCAPTCHA service before you enable it.
Alternatively, you can enable the HPM Smart Bot Attacking Prevention feature through Zuora Global Support. HPM Smart Bot Attacking Prevention is an opt-in auto-adjusting security feature that dynamically enables and configures reCAPTCHA Enterprise Interactive Test (Checkbox) version when attacks are identified.
For more information about the support for reCAPTCHA Enterprise, see Security measures for Payment Pages 2.0.
Deprecation of the "Submit hosted page requests via DirectPOST" setting
The Submit hosted page requests via DirectPOST setting is intended to prevent CAPTCHA challenges from interacting with the Direct POST requests. On 8 November 2022 PDT, this setting was deprecated from Zuora UI in production environments. After this setting is deprecated, customers using Direct POST do not need to make any changes. Google reCAPTCHA is disabled on the hosted payment pages that are submitted through Direct POST.
This change went live on sandbox tenants on 3 November 2022.
For more information about the support for reCAPTCHA Enterprise, see Security measures for Payment Pages 2.0.
Support for passing additional CIT fields to CyberSource
To be compliant with CyberSource’s latest integration guide, we have improved the CyberSource v2.0 integration to support passing two additional fields to the gateway.
A new setting called Send Extra CIT Fields is now available on the gateway setting page. With this setting selected, when validating credit card and Apple Pay payment methods for cardholder-initiated transactions (CITs), the following fields will be sent to the payment gateway:
- firstRecurringPayment
- subsequentAuthStoredCredential
In December 2022, we plan to remove the Send Extra CIT Fields setting from Zuora UI and enforce passing the preceding two fields to payment gateways.
For more information, see CyberSource Payment Gateway.
New gateway option fields available on CyberSource for passing ShipTo address information
You can now submit ShipTo address information through CyberSource Payment API v2.0 gateway integration to the gateway by using the gateway option fields. You can use the supported fields through Payment Pages 2.0 and supported APIs.
For more information about the supported ShipTo fields, see Supported gateway option fields for CyberSource.
HPM submission rate limiting feature available for Payment Pages 2.0
As a tightened security measure of Payment Pages 2.0, in addition to IP-based and card-based rate limiting measures, the HPM submission rate limiting feature is now enabled in all production environments. With this feature enabled, the maximum number of attempts to submit payment pages from the same tenant is configured with a group of thresholds by Zuora. If the number of page submissions from the same tenant exceeds the configured thresholds, an error occurs and submissions from the tenant are blocked.
For more information, see Security Measures for Payment Pages 2.0.
Zuora Central Platform
System Health
New System Health dashboards available
We have now released the following dashboards:
| System Health dashboard | Data contained in the dashboard |
| Journal Run | Zuora System Health dashboard for Journal Run (Journal Run dashboard) collects and displays data about Journal Run usage, failure, and performance in near real-time. |
| Trial Balance Run | Zuora System Health dashboard for Trial Balance Run (Trial Balance dashboard) collects and displays data about Trial Balance Run usage, failure, and performance in near real-time. |
For the initial few days, only seven days of data is available.
REST API
Zuora REST API provides comprehensive support for common business use cases.
API for Billing, Collect, and Platform
For the detailed API documentation, see API Reference.
For a summary of REST API updates and documentation updates in the Zuora API Reference, see 2022 API Changelog.
Quickstart API
From 2022.09.R1, the Quickstart API is available to all customers, which allows new integrators to swiftly integrate with Zuora. The Quickstart API supports essential business use cases.
For the detailed Quickstart API documentation, see Quickstart API Reference.
For a summary of REST API updates and documentation updates in the Quickstart API Reference, see Quickstart API Changelog.
SOAP API
Current WSDL version: 127
For information about how to check your version and download the latest version. see Zuora WSDL.
SOAP API change history
For a summary of updates made to the SOAP API in recent Zuora releases, see Zuora SOAP API Version History.