Zuora Release 2022.03.R3
Welcome to the release notes for Zuora Release 2022.03.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.
In this release, an enhancement is introduced to the new UI of both Zuora Billing and Zuora Collect. To help you easily find a navigation item in the navigation bar, a search component is added to the top of the navigation bar. You can use this search component to find any navigation item no matter whether it is collapsed and navigate to the target page directly.
Orders and Subscriptions
One-time per unit charge model supported when adding order line item from product catalog
When adding an order line item from the product catalog, you can now add a product rate plan charge of the one-time per unit type as an order line item either through the Create an order operation or the Orders UI.
New fields to represent dates of subscription creation or amendment for Zuora Billing - Revenue Integration
Several new fields are now available on various objects in Zuora Billing to represent dates of subscription creation or amendment for Zuora Billing - Revenue Integration. This enhancement is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. These fields are mapped as the booking dates for sale order lines in Zuora Revenue.
If you are existing customers for Zuora Billing - Revenue Integration, submit a request at Zuora Global Support for data migration. Note that the field mapping to Zuora Revenue will take effect in upcoming releases.
Details about the new fields are as follows:
The following field is now available on the Amendment object:
bookingDate: the date when the amendment is signed
The following fields are now available on the Rate Plan Charge object:
originalOrderDate: the date when the rate plan charge is created through an order or amendment
amendedByOrderOn: the date when the rate plan charge is amended through an order or amendment
The following fields are now available on the Order Line Item object:
originalOrderDate: the date when the order line item is created through an order
amendedByOrderOn: Note that this field is for future use, so the value for this field is currently always
The Zuora UI, API, and data source have been enhanced to support these fields. Details are as follows:
- You can set the
bookingDatefield for an amendment through both the Zuora UI and API. You can access this field for an amendment through the Zuora UI, SOAP API, and Amendment data source.
- You can access the
amendedByOrderOnfields for a rate plan charge through the Zuora REST API, SOAP API, and Rate Plan Charge data source.
- You can access the
amendedByOrderOnfields for an order line item through the Zuora REST API and Order Line Item data source.
New fields on Order details page
An enhancement has been made in the Orders UI. You can now view the
Created By and
Created On fields on the Order details page when viewing details of an order.
Usage and Rating
Prepaid with Drawdown feature now available for Early Adopters
The Prepaid with Drawdown feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
The Prepaid with Drawdown feature offers a new pricing model for your consumption-based subscription business. Using this model, your customers pay upfront to receive a number of consumable units, then consume against that prepaid balance with the possibility of topping up more units or being charged for any overage.
With this feature enabled, you will have the following key capabilities:
- Configure prepayment charges and drawdown charges in your product catalog with greater flexibility.
- Specify a validity period during which the prepaid units are valid to use.
- Meter usage and consumption in different Units of Measurement.
- Subscribe customers through Orders and manage their subscriptions through various Order actions.
- Track changes to your customer’s prepaid balance throughout the subscription lifecycle.
See Prepaid with Drawdown for more information.
Invoicing and Tax
New fields on Invoice, Credit Memo, Debit Memo, Credit Memo Item, and Debit Memo Item objects
To help you identify the source of creation of an invoice, a memo, or a memo item, the
sourceItemTypefields are now available on the following objects through data sources, REST API, and SOAP API:
- Credit Memo
- Debit Memo
- Credit Memo Item
- Debit Memo Item
New mail merge field available in Word invoice and memo templates
When defining Word invoice and memo templates, you can now use a new mail merge field called
TaxItem.TaxCodeDescription within tax items tables to add a description for a tax code.
For more information, see the following articles:
Resolved: InvoiceItem.Quantity format was displayed improperly in Word invoice templates
Previously, the format of the
InvoiceItem.Quantity mail merge field could not be displayed properly in Word invoice templates.
This issue has been resolved. The merge field format can now be displayed properly if you set the Format numeric merge fields based on communication profile locales? billing rule to Yes.
New fields available on Invoice, Credit Memo, and Debit Memo objects
Several fields are now available on various objects in Zuora Billing through data sources, SOAP API, and REST API for a new feature of upcoming releases to provide flexible billing. With this feature, you can specify the bill-to contact and payment term at the subscription level and invoice subscriptions per the same bill-to contact and payment term. Details about the new fields are as follows:
The following fields are now available on the Invoice object:
The following field is now available on the Credit Memo object:
The following fields are now available on the Debit Memo object:
Additional documentation will be available upon future releases.
The latest version of Zuora 360+ is released on March 2, 2022.
For the latest changes of Zuora 360+, see Zuora 360+ release notes.
Payment REST APIs now support returning the account number field
The following payment REST APIs now support returning the accountNumber field:
- Create a payment
- Update a payment
- Get payments
- Retrieve a payment by ID
- Transfer a payment
- Apply a payment
- Cancel a payment
- Unapply a payment
This field indicates the number of the customer account that the payment is created for. For more information, see the Payments section in the API reference.
Zuora Central Platform
Support for auditing custom field changes
To help you meet audit requirements and maintain compliance, Audit Trail now supports the capability of tracking when custom fields are created, modified, and deleted. These changes are represented as
CustomFieldDefinition objects in Audit Trail. You can use Data Query to run a report against the auditsettingchangeevent table to retrieve the records.
Audit Trail supports tracking changes in the following custom field types:
For information about custom fields, see Manage custom fields.
Support for auditing Chase Orbital payment gateway configuration changes
To help you meet audit requirements and maintain compliance, Audit Trail now supports the capability of tracking the creation and modification of the Chase Orbital payment gateway configuration. These changes are represented as
PaymentGateway objects in Audit Trail. You can use Data Query to run a report against the auditobjectchangeevent table to retrieve the records. Administrators can enable or disable auditing the changes through Manage Audit Trail settings.
Callout definitions no longer reset for each Central Sandbox refresh
This enhancement will be available only in the Production environments.
Starting from this release, we no longer resets previously copied callout definitions from production to your Central Sandbox tenant. This enhancement saves you from repeatedly configuring callout definitions after Central Sandbox refreshes. On each refresh, the existing callout templates will remain unchanged, and deleted callout templates will be removed.
For a summary of REST API updates and documentation updates in the Zuora API Reference, see 2022 API Changelog.
Current WSDL version: 118
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.