Skip to main content

Zuora Release 2023.04.R2


Zuora Release 2023.04.R2

Welcome to the release notes for Zuora Release 2023.04.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.

Zuora Billing

here_black.png Orders and Subscriptions

API enhancements to automatic refunding after subscription cancellations

We made the following API enhancements to the request body and response body of the Create an order operation for canceling a subscription with a refund and write-off:

  • In the request body, we added the refundReasonCode field identifying the reason for the refund transaction.
  • In the response body, we changed the response structure and added the refundInvoiceNumbers nested field under the refunds field and the writeOffCreditMemoNumber nested field under the writeOfffield. 

For more information, see Cancel subscriptions and refund end customers automatically.

Resolved: wrongly triggered email notifications when saving draft orders

Previously, you could save your orders as draft orders successfully. However, when you verified the Result of your events from Billing SettingsSetup Profiles, Notifications and Email Templates > Email History, you could see a failure error "'To Email Address' is required." were wrongly triggered. 

Now, we resolved the issue as follows:

  • If your events are the Order Action Processed and Order Processed related events that are listed in the Notifications tab, you will no longer see this error.
  • If your events are the Order and OrderAction objects based custom events that are listed in the Custom Events tab, you can skip the failure errors or send notifications by setting condition rules on the Order and Order Action objects.
Object Set condition rules to skip the failure errors when saving draft orders Set condition rules to send notifications when saving draft orders
Order (changeType == 'INSERT' && Order.Status != 'Draft') || (changeType == 'UPDATE' && Order.Status != 'Draft' && Order.Status_old == 'Draft') (changeType == 'INSERT' && Order.Status == 'Draft') || (changeType == 'UPDATE' && Order.Status == 'Draft')
OrderAction (changeType == 'INSERT' && OrderAction.Status != 'Draft' && OrderAction.AutoGenerated == 'false') || (changeType == 'UPDATE' && OrderAction.Status != 'Draft' && OrderAction.Status_old == 'Draft') (changeType == 'INSERT' && OrderAction.Status == 'Draft') || (changeType == 'UPDATE' && OrderAction.Status == 'Draft')

To set the condition rules, you can use either of the following methods:

here_black.png Usage and Rating

Prepaid Cash With Drawdown available for early adopters

Note: The Prepaid Cash 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.

You can now collect payment from your subscribers and then deposit the payment on their customer account as a reserved payment. Subscriptions can be configured to consume this reserved payment amount upon invoice post or payment run. By collecting the payment in advance, the Prepaid Cash with Drawdown feature is beneficial for cash flow. It also diversifies your pricing strategy by enabling subscribers to purchase products or services at a lower price. 

The following steps briefly describe how Prepaid Cash with Drawdown works:

  1. Use payment schedules or payments to deposit payment on a customer account. A new prepayment field is now available on the Payment Schedule and Payment objects to indicate whether the payments created will be counted as the reserved payment amount on the customer account.
  2. After the deposit is made, you can view the amount on the customer accounts.
  3. Create subscriptions that will consume the prepayment amount. A new field prepayment is available to indicate whether the subscription will consume the reserved payment amount.
  4. When the invoices are posted, Zuora will first attempt to use the prepaid amount of the customer account to pay for the billed amount. If the balance is less than the billed amount, a payment will be created to collect the remaining amount.

The Prepaid Cash feature is part of Advanced Consumption Billing. For more information, see Advanced Consumption Billing

Enhancement to bill credit for recurring charges calculation 

A new billing rule called When bill credit for recurring charges, based on billed period or credit period? is now available. With this new billing rule, you can have the credit amount calculated by considering the total billing period and the charged amount during the period by selecting Based on the total billing period amount and charged amount

Note that all the new tenants have Based on the total billing period amount and charged amount selected by default.

For more information about billing credit for recurring charges, see Probation credit.

up-arrow.png Back to Table of Contents

Zuora Collect

here_black.png Payments

Support for passing Safetech Fraud parameters to Chase through Create authorization API operation

A new setting called Enable Safetech Fraud Service for Delay Capture Authorization is now available for the Chase Paymentech Orbital Gateway integration. If this setting is enabled, the Safetech Fraud parameters will be passed to the Safetech Fraud Management tool for evaluation through the Create authorization API operation.

Previously, we only supported passing Safetech Fraud parameters when verifying payment methods.

For more information, see Set up and configure a Chase Orbital payment gateway instance.

Label change of setting for enabling Safetech Fraud service when verifying payment methods

For better clarity, the Enable Safetech Fraud Service setting on the configuration page of each of the following payment gateway integrations is renamed to Enable Safetech Fraud Service for Payment Method Verification:

  • Chase Paymentech Orbital Gateway
  • Chase Paymentech Orbital Gateway, API v7.0.1

For more information, see Set up and configure a Chase Orbital payment gateway instance.

Helix payment gateway integration available

A new payment gateway integration called Helix Payment Gateway is now available in Zuora. It integrates with the Helix Merchant Payments API powered by J.P. Morgan Chase to support the following payment operations for credit card payment methods:

  • Payment method validation
  • Payment
  • Referenced refund
  • Non-referenced refund

The Helix payment gateway integration also supports stored credential transactions.

This feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters.

For more information about the Helix payment gateway integration, see Overview of Helix payment gateway integration.

Enhancement in passing field to Adyen in delayed capture

When making a payment in a delayed capture process for a Credit Card or Google Pay payment method on Adyen, we now pass the payment number through the reference field to the gateway. Previously, a random reference ID was passed.

For more information, see Overview of Adyen Integration v2.0.

up-arrow.png Back to Table of Contents

Zuora Central Platform

here_black.png Custom Fields

Additional custom field types for Billing objects

To provide a unified and seamless user experience in using custom fields in Zuora, the following custom field types will be available for Billing objects:

  • Boolean
  • Date and Time
  • Integer
  • Number

Previously, these custom field types were only available for Custom Objects.

Note that the Boolean, Integer, and Number custom field types are available from this release. The Date and Time type will be available in later releases.

Boolean, Integer, and Number custom field types available for Billing objects

The Boolean, Integer, and Number custom field types are now available for customizable Billing objects, such as Account, Product, Subscription, and other objects.

You can specify the default value for custom fields of these types. The data values that can be recorded in custom fields of each type are as follows:

  • Boolean: data with binary values, such as True, False, Yes, or No.
  • Integer: data with integer values, such as 5, -18, or 0.
  • Number: data with integer and decimal values, such as 5, -18, 0, 20.6, or -100.32.

Previously, these custom field types were only available for Custom Objects.

Be aware of the following limitations when using these field types:

  • The Integer and Number field types apply only to non-indexed custom fields.
  • Zuora has built-in minimum and maximum values for custom fields with the Integer or Number field type.
    Note that you will be able to specify these values in later releases.

For more information about custom fields and supported Billing objects, see Manage custom fields and Objects that support custom fields in Zuora.

here_black.png Workflow 

JavaScript Support

You can now use JavaScript APIs to access and manage instances, paths, tasks, and transitions. With growing complex business logic and the rarity of the liquid templating framework, Zuora has developed a JavaScript task that helps you manipulate and write back data payload variables. Furthermore, a JavaScript tester will facilitate you to test and separate codes on the Swimlane page. Over time, Zuora will roll out JavaScript and Liquid testers to the canvas.

For more information about JavaScript Workflow tasks, see JavaScript Task.

up-arrow.png Back to Table of Contents


For the detailed API documentation, see API Reference.

For a summary of REST API updates and documentation updates in the Zuora API Reference, see 2023 API Changelog

Quickstart API 

From 2022.09.R1, the Quickstart API is available to you if you have the Orders (or Order Harmonization) and Invoice Settlement features enabled in your tenant. The QuickstartAPI allows new integrators to swiftly integrate with Zuora, and it 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

Flexibility on listing only the fields you need in response

The Quickstart API now supports returning only a subset of fields on the queried object or its associated objects in the response. You can use the <object>.fields[] query parameter to specify specific top-level fields on the queried object or the supported associated objects to be returned in the response.

With this feature, you have the flexibility to get only the fields you want in the response while the API performance is significantly improved.

For more information, see the following pages:


Current WSDL version: 133

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.