Zuora Release 2022.06.R3
Welcome to the release notes for Zuora Release 2022.06.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.
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.
Zuora Billing
Orders and Subscriptions
Inline discounts supported on order line items
You can now apply discounts on order line items by specifying inline discounts. The following fields are now available on the Order Line Item object to support inline discounts:
inlineDiscountType
: an enum value. Use this field to specify the inline discount type, which can bePercentage
,FixedAmount
, orNone
.inlineDiscountPerUnit
: a number value. Use this field in accordance with theinlineDiscountType
field, in the following manner:- If the
inlineDiscountType
field is set asPercentage
, this field specifies the discount percentage for each unit of the order line item. - If the
inlineDiscountType
field is set asFixedAmount
, this field specifies the discount amount on each unit of the order line item.
- If the
discount
: a number value. This field shows the total discount amount that is applied to an order line item after the inline discount fields above are set.
The Zuora UI, API, data source, and data query have been enhanced to support inline discounts.
In addition, the Zuora UI supports the automatic generation of values for the relevant discounting and pricing fields, including inlineDiscountPerUnit
, listPricePerUnit
, and amountPerUnit
. The logic is that when two of the previous fields are set, the remaining field is automatically generated in the UI.
Note that inline discounts on order line items are different from discounts on rate plan charges. The inline discount is implemented as a discount to specify directly through setting the inline discount fields, and it is applied to the list price of an order line item. The discount on a rate plan charge is implemented as a discount charge, and it is applied to the sale price of a rate plan charge.
The support of inline discounts for Zuora Billing - Revenue Integration is planned for future releases.
Booking Transaction object available in data source and data query
The Booking Transaction object is now available in the data source and data query. This object stores data and data change on the Zuora Billing side. It provides the systems downstream of Zuora Billing with consistent and traceable data, such as the order and booking data for Zuora Revenue.
This object is now only available to the tenants with Zuora Billing - Revenue Integration enabled. If you want access to this object, submit a request at Zuora Global Support.
For more information, see here.
Invoicing and Tax
REST API enhancements for memo management
The following API operations have been enhanced to support managing credit or debit memos by memo number:
- Create a credit memo from a charge
- Create a credit memo from an invoice
- Retrieve a credit memo
- List credit memo items
- Retrieve a credit memo item
- Email a credit memo
- Upload a file for a credit memo
- Generate a credit memo PDF file
- Post a credit memo
- Reverse a credit memo
- Unpost a credit memo
- Create a debit memo from an invoice
- Retrieve a debit memo
- List debit memo items
- Retrieve a debit memo item
- Email a debit memo
- Upload a file for a debit memo
- Generate a debit memo PDF file
- Post a debit memo
- Unpost a debit memo
Previously, these API operations only supported managing credit or debit memos by memo ID.
For more information about the specific API changes, see "API Optimization for Object Key Support" in 2022 API Changelog (2022-06-16).
Create Standalone Invoice permission available for existing Billing standard users
Starting from this release, all existing Billing standard users will have the “Create Standalone Invoice” permission enabled.
Since Zuora Release 2022.03.R5, newly created Billing standard users have had the “Create Standalone Invoice” permission enabled by default.
Enhancement to configurable tax app
You can now use theproductName
andproductRatePlanChageName
fields at the document item level when building tax app templates. This enhancement saves effort when your tax vendor requires product details in the request for taxation in certain countries or regions, such as Japan.
Zuora CPQ
Zuora Quotes
We recently released patch releases on top of Zuora Quotes version 10.7. The latest version is 10.7.1.
For the release notes of Zuora Quotes, see Zuora Quotes version 10 release notes.
Zuora Collect
Payments
Smart Retry functionality of Configurable Payment Retry has enhanced response code mappings
Now Smart Retry functionality of Configurable Payment Retry has enhanced response code mappings. When Smart Retry is enabled, you can stop retrying a payment for the response codes mapped to hard decline. To enable Smart Retry, in Configurable Payment Retry, navigate to the Customer Group with Smart Retry enabled and click Stop Retry on Hard Declines.
Previously, even when a payment is hard declined, the smart retry features continue retrying the payment.
For more information, see Enable Smart Retry.
General availability of support for processing Indian local recurring payments through one-time payment flows
The support for processing Indian local recurring payments through one-time payment flows is now generally available to all Zuora customers. You can implement a one-time payment flow for Credit Card Reference Transaction payment methods on the Stripe v2 payment gateway integration to support processing Indian local recurring payments. Previously, you had to submit a request at Zuora Global Support to enable this feature.
Enhancements on stored credential transaction support for Braintree
We have extended the support of stored credential transactions for the following card brands on the Braintree Gateway integration:
- American Express
- JCB
For more information, see Support for stored credential transactions overview.
Enhancements to Payment Gateway Reconciliation API operations
We have made the following enhancements to the Payment Gateway Reconciliation API operations:
- You can now specify payments using the payment-key field that accepts either the unique payment ID or the payment number. Previously, you could only use the payment ID to specify payments.
- You can now specify refunds using the refund-key field that accepts either the unique refund ID or the refund number. Previously, you could only use the refund ID to specify payments.
- The error messages have been enhanced to be as follows for the errors that occur when the specified payment key does not match any payment:
API Operation Scenario Previous error message Current error message The "Settle a payment" REST API The payment key specified does not match any payment Cannot find a payment with id {payment-id}. Cannot find a payment with key {payment -key}
The "Reject a payment" REST API The "Reverse a payment" REST API Transaction has been deleted and cannot be acted upon
Zuora Central Platform
Tenant Management
Support for Custom Roles in Deployment Manager
Previously, to run deployments, Platform Admin access was required, which restricted the usage of the product as not all users will have that access.
Now, Deployment Manager permission has been incorporated for custom roles. It is now possible for Administrators to provide users with the access to perform deployments by creating a custom role and providing permission for the role by selecting a checkbox. Users can manage Deployment Manager access at the tenant level.
Currently, we are working on resolving the issues, therefore Deployment Manager needs to be deployed to both Users and Tenants for the time being.
Note that, to add and authenticate Source Tenants, users must have the Platform Admin role.
See Create a custom user role and Platform roles for more information.
Enhancements to Deployment Manager Administrative Access
Previously, users with administrator access to Deployment Manager needed Platform Admin permission to run deployments.
Now, users with administrator rights will have access to Deployment Manager by default.
Currently, we are working on resolving the issues, therefore Deployment Manager needs to be deployed to both Users and Tenants for the time being.
Events and Notifications
Support for retrying domain identity verification of advanced SMTP server
If the domain identity verification of the advanced SMTP server fails, you can now retry the verification by clicking the Retry button on the Manage SMTP Settings page. Previously, you had to delete the domain identity and create another one.
REST API
For a summary of REST API updates and documentation updates in the Zuora API Reference, see 2022 API Changelog.
New error category code now available
Previously, when calling Zuora REST API, you would get an internal error with the 60
category code if a temporary error occurred during API request processing. It was difficult for you to identify the root cause based on the returned error message.
Therefore, we have introduced the 61
error category code to indicate that a temporary error occurs and you can have another try later. For example, if a database communication error occurs when calling the List order metrics for an evergreen subscription operation, you would get the following error:
{ ... "reasons": [{ "code": 50000061, "message": "Oops, operation failed due to a temporary error, please retry later." }] }
Additionally, the error message for the existing 60
error category code is changed to Oops, internal error occurred, please contact Zuora support.
for more clarity.
For more information, see Error category codes.
SOAP API
Current WSDL version: 123
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.