Zuora Release 2022.01.R3
Welcome to the release notes for Zuora Release 2022.01.R3. 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. For more information about the recent changes to the Zuora release management process, see Attention: Changes To The Zuora Release Management Process in Zuora Community.
For release schedule details, see this release notification.
Join Release Notifications in Zuora Community to receive timely notifications about Zuora Billing, Collect, and Central Platform.
Orders and Subscriptions
New field in Order Action data source
A field called
Auto Generated is now available in the Order Action data source. Customers who use the Order Harmonization feature can use this field to determine whether an order action is automatically generated by the system or created through the Create an order operation. Possible values for the field are as follows:
TRUE: The order action is automatically generated by the system as a result of a subscription or amendment created through the Subscribe and Amend APIs.
FALSE: The order action is created through the "Create an order" API operation.
For more information about this field, see Order Action data source.
Behavior change in notifications for Orders Harmonization tenants
Previously in the tenants with the Orders Harmonization feature enabled, the default notification behavior was as follows:
- Both order notifications and amendment notifications were triggered for any subscription creation or amendment created through the Subscribe and Amend APIs.
- Both order notifications and amendment notifications were triggered for any order action created through the Create an order operation.
We have now changed the default notification behavior in the tenants with Orders Harmonization enabled to the following:
- Only amendment notifications are triggered for amendments that are created through the Subscribe and Amend APIs.
- Only order notifications are triggered for order actions that are created through the “Create an order” operation.
Note that amendment notifications are sent only to the subscription owner of a subscription and order notifications are sent only to the invoice owner of a subscription.
As of Zuora Release 2022.01.R3, any new customers onboard on Orders Harmonization will have the new default notification behavior in their tenants.
If you are an existing Orders Harmonization customer, the existing notification behavior in your tenant remains unchanged. If you want to enable the new default notification behavior, submit a request at Zuora Global Support.
New fields to represent subscriptions and rate plans created through third-party stores
The following fields are now available to represent subscriptions and rate plans created through third-party stores.
externallyManagedBy: an enum field on the Subscription object to indicate the name of a third-party store, possible values include
externallyManagedPlanId: a text field on the Subscription Rate Plan object to indicate the unique identifier for the rate plan purchased on a third-party store.
For more information about the specific API updates, see 2022 API Changelog, API Reference: Billing, and Zuora SOAP API Version History.
For more information about the fields, see Rate Plan data source, Subscription data source, and Data Query.
Invoicing and Invoice Settlement
Billing administrator permission required for accessing configurable tax apps
Starting from February 25, 2022, with the sandbox deployment of Zuora Release 2022.03.R1, a billing user role with the Administrator permission is required to access configurable tax apps in your tenant. With this permission change, only administrators who manage billing settings will have access to the tax apps.
Before the 2022.03.R1 release, the tax apps can be accessed by all users under the Marketplace section from the left-side navigation bar. From this release, the tax apps will be moved to the Setup Tax Engine and Tax Date section, which is accessible by administrators from the Billing Settings page.
The latest Zuora Quotes version is 10.2.
For the release notes of Zuora Quotes, see Zuora Quotes version 10 release notes.
Support for specifying custom fields of Payment object when creating payment run through REST API
For the custom fields that have been defined for the Payment object, you can now set values to the custom fields when creating a payment run through the Create a payment run API operation. You can specify the custom fields in the
data field for a payment record.
For more information on specifying custom fields, see Create a payment run in API Reference and Create custom payment runs through Zuora REST API in the Knowledge Center. For more information about defining custom fields, see Manage custom fields in the Knowledge Center.
General availability of OPM service
The Open Payment Method (OPM) service is now generally available to all Zuora customers. With the support of the OPM service, you can define your custom payment method types and create custom payment methods of the defined types. The custom payment method of the defined type can only be used with the custom payment gateway that you set up through the Universal Payment Connector (UPC) service.
Previously, you had to submit a request at Zuora Global Support to enable the OPM service.
For more information, see Set up custom payment gateways and payment methods.
Zuora Central Platform
Events and Notifications
Credit balance parameters available for Invoice Posted callout notifications
You can now add the following credit balance parameters when you configure callout notifications for the Invoice Posted event:
With this enhancement, you can configure callout notifications to receive callouts with the credit balance information included when invoices are posted.
For more information about creating callout notifications, see Configure callout notifications.
List callout notification histories operation now returns callout parameters for Credit Memo based events
We have enhanced the "List callout notification histories" API operation to return the configured callout parameters within the
eventContext field for Credit Memo object based events. This enhancement provides consistency with callout history responses for other events, such as Invoice object based events.
Tabs for custom events based notification history removed from your tenant
We have migrated notification history data that is based on your custom events. This type of notification history data is now stored and displayed inline with notification history data for standard events. In the Zuora UI, only the Email History and Callout History tabs are displayed on the following pages:
- Customer account details page
- The Notification History tab by navigating to Billing, Payments, or Finance Settings > Setup Profiles, Notifications and Email Templates.
The Email History (from Event Triggers) and Callout History (from Event Triggers) tabs that were designed for custom events are now removed.
Validation on duplicate notification names introduced for UI and API
We have introduced validation on notification names to ensure that no duplicate notification names exist for one communication profile.
If you attempt to create or update a notification through the UI or API and use the same name as an existing notification for the same communication profile, the creation or update will fail with an error message.
This enhancement reinforces the uniqueness of notification names, which can improve your experience in importing and exporting notifications across different tenants.
UI enhancements to Zuora Notification settings
To improve your overall experience with Zuora notifications, we have made the following changes in the Zuora UI:
Moved callout settings to the Administration Settings page as the Manage Callout Settings administration setting for easier access and greater visibility. You can now configure callout options by navigating to Administration Settings > Manage Callout Settings.
Previously, the following steps are required to configure callout settings:
- Navigate to Billing Settings, Payments Settings, or Finance Settings.
- Click Setup Profiles, Notifications and Email Templates.
- Click the Callout Options tab.
Renamed the External SMTP setting to Manage SMTP Settings for consistency.
- Grouped the following closely related administration settings for better usability:
- Manage OAuth 2.0 Providers
- Manage Callout Settings
- Manage External SMTP
Disabled custom field picklist options unavailable in object creation or updates through API
Since the 2021.12.R1 release, you can disable picklist options for custom fields through the Zuora UI. After a custom field picklist option is disabled, you cannot use it to create or update objects through the Zuora UI.
From this release, you also cannot use disabled picklist options for custom fields when you create or update objects through the API. This enhancement ensures the behavior consistency between the Zuora UI and API.
Note that you can still query objects using disabled picklist options through the API for backward compatibility.
Merge task with data reconciliation support available in all Sandbox environments
The Logic: Merge task with data reconciliation support is now available in all Sandbox environments for you to test. This task enables merging two or more branches into a single subsequent branch based on the completion of all pre-merged branches. All data processed within the upstream branches are captured and returned as a single output, which can be processed by the subsequent branch. This task simplifies configuring branched processes that complete before a workflow completes.
For more information, see Logic: Merge.
For a summary of REST API updates and documentation updates in the Zuora API Reference, see 2022 API Changelog.
Current WSDL version: 115
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.