Zuora Release 2024.05.R1

Enhancements on Orders and Subscriptions API

We enhanced the Orders and Subscriptions API as follows:

Enhancements on Orders API

• In the request body of the "Retrieve an order" operation, we added the getAccountDetails query parameter. If the getAccountDetails query parameter is set to true, the response includes the invoice owner account details and subscription owner account details. 
• In the response body of the "Create an order" operation, we added the subscriptionOwnerNumber and subscriptionOwnerID fields to present the subscription owner number and ID.

Enhancements on Subscriptions API

In the request body of the "Retrieve a subscription by key" operation, we added the getSubscriptionOwnerDetails and getInvoiceOwnerDetails query parameters. The returned result is as follows:

• If the getSubscriptionOwnerDetails query parameter is set to true, the response includes the subscription owner account details.
• If the getInvoiceOwnerDetails query parameter is set to true, the response includes the invoice owner account details. 
• If both query parameters are set to true, the response includes the subscription owner account details and invoice owner account details. 

Deprecation of Amend and Subscribe features

The Subscribe and Amend features are approaching end of support on February 16, 2026. 

During the deprecation period through February 15, 2026, Zuora will no longer actively develop or enhance the Subscribe and Amend features. Only critical, revenue-impacting defects with no workarounds or alternatives may be fixed at Zuora’s discretion. Customers should start planning for the required changes and begin the transition process to Orders. For more information, see Product and feature end of support plan.

Enhancement to Standalone Order feature

We have enhanced the Standalone Order feature. You can now use a standalone order to create a Minimum Commitment subscription. 

Enhancement on Billing Schedule

We have enhanced the Billing Schedule feature to support the Terms And Conditions order action for subscriptions containing discount charges. Previously, when a one-time charge in such a subscription was associated with a billing schedule, you could not perform the order action on the subscription. 

With the enhancement, this order action is now permitted as long as the one-time charge and its associated discount charges do not affect the total amount of the billing schedule. For example, you can use this order action to adjust the subscription term start date and end date if the same discount charges are still applied to the one-time charge. For more information, see Update subscription term start and service activation dates to align with GLD.

Note that this order action is still not supported if a subscription only contains recurring charges.

Period Start Date, Period End Date, and Taxable Amount fields for Multiple Taxation Items

We have now introduced the following new fields within TaxationItem, CreditTaxationItem, and DebitTaxationItem in Data Query:

• PeriodStartDate - Displays the tax rate and tax rate start date directly on the invoice PDF for all tax engines.
• PeriodEndDate - Displays the tax rate and tax rate end date directly on the invoice PDF for all tax engines.
• TaxableAmount -  Displays the taxable amount only when the Z-Tax engine is used and loses relevance when alternative tax engines are employed.

These additions facilitate the display of tax rate and tax rate period details directly on the invoice PDF. With these fields, you can now ensure accurate representation of separate rates for distinct periods, particularly when an invoice item's service period extends across multiple tax rate periods.

These fields on TaxationItem are always the same as the ones on the InvoiceItem, provided you do not use the Generation of multiple taxation items feature. If you use the feature, then configure the rule as Multiple Tax Items. This configuration ensures precise tax calculation when an invoice item's service period overlaps multiple tax rate periods.

Deprecation of Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features

The Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features are approaching end of support on February 16, 2026. 

During the deprecation period through February 15, 2026, Zuora will no longer actively develop or enhance the Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features. Only critical, revenue-impacting defects with no workarounds or alternatives may be fixed at Zuora’s discretion. Customers should start planning for the required changes and begin the transition process to Invoice settlement. For more information, see Product and feature end of support plan.

Enhancements on scheduled bill runs

We enhanced the scheduled dates of the monthly scheduled bill runs, and made the enhancements at the following places:

• “Create bill run” API operation
• Create Scheduled Bill Run UI page
• Bill Run Data Query

Enhancement on bill run date

The Bill Run Date you specified is the date that the first bill run is executed. 

Previously, after you specified the Repeats field as Monthly and the Bill Run Date field, the bill run date could only recur on the same day of each month. 

Now, after specifying the Repeats field as Monthly and the Bill Run Date field as the end day of a month, you can choose one of the following options:

• Monthly on day X: The bill run date still recurs on the same X day of each month based on your specified Bill Run Date. 
• Always on month end: The bill run date recurs on the end day of each month. 

Enhancements on invoice date and target date

The Invoice Date is the invoice date displayed on the invoices, and the Target Date is used to determine which charges are to be billed. Take the Invoice Date as an example, and the Target Date is similar. 

Previously, after you specified the Bill Run Date and Invoice Date fields, invoices could only be generated before or after a fixed number of days from the bill run dates. The fixed number of days is calculated based on the difference in days between your specified Bill Run Date and Invoice Date. 

Now, after specifying the Repeats field as Monthly and the Invoice Date field as the end day of a month, you can schedule the invoice dates recur in one of the following ways:

• Still recur before or after a fixed number of days from the bill run dates
• Recur before or after a fixed number of months from the bill run dates, and the day value is a day of the month (for example, 29) specified in the Invoice Date field.
• Recur before or after a fixed number of months from the bill run dates, and the day value is the end day of the month.

For more information, see Create bill runs and Monthly Scheduled bill run use cases.

Support for previewing scheduled dates

We added a preview section at the right on the Create Scheduled Bill Run UI page.

After creating a scheduled bill run, you can preview the recurrence and scheduled bill run dates, invoice dates, and target dates in the preview section. 

For more information, see Create bill runs.

Enhancement of e-invoicing file template for Sovos

For Sovos, previously we didn’t provide the Invoice, Credit Memo, and Debit Memo default e-invoicing file templates for countries that are not pre-integrated. For more information, see Pre-integrated countries.

We now provide these default e-invoicing file templates for countries that are not pre-integrated for Sovos. The default e-invoicing file templates include the following common tags:

• AccountingSupplierParty
• AccountingCustomerParty
• Invoice and InvoiceLine

UI enhancement on response field mappings

Previously, if the service provider was specified as Sovos, when you configured the Response Mapping section, you could always click +Add Field Mapping no matter which country was specified in the Basic Info section.

We enhanced the Response Mapping section. The +Add Field Mapping is no longer available for the pre-integrated countries. The default response mappings have been configured and cannot be changed for these pre-integrated countries. For more information, see Configure e-invoicing response field mappings.

Standalone credit and debit memos support customized memo numbers through REST API

You can now specify customized memo numbers when creating standalone credit or debit memos through the REST API. Previously, the memo numbers were generated by Zuora.

This enhancement allows you to customize the memo numbers to suit your business needs. For example, you can use the numbers from external billing systems.

Note that if you do not specify the memo number when creating a standalone credit or debit memo, Zuora will generate a unique number per the sequence set on the account level. If the account-level sequence set is not specified, the system default sequence set is used. For more information, see Configure prefix and numbering for billing documents.

 Back to Table of Contents

User permission available for Payment Gateway Routing

We have now introduced the Edit Payment Gateway Routing user permission for the Payments role. Users with this permission can create and edit rules. Users without this permission can only view existing rules.

• For tenants created after the 2024.05.R1 release, this permission is not granted to Standard User by default. You have to select it manually for your Standard User role.
• For existing tenants, this permission is granted to Standard User by default.

For more information, see the following articles:

• Payments roles
• Create and manage Payment Gateway Routing rules

Enhancements to trial balance run

You can trigger a trial balance run for not more than 12 accounting periods. However, only one trial balance job runs at a time; the subsequent jobs will wait for the previous job to complete.

For more information, see Run a trial balance.

 Back to Table of Contents

Support for cloning email templates

You can now clone email templates through the Zuora UI. This enhancement simplifies the creation of email templates by using existing templates as the foundation.

For more information, see Clone an email template.

Subregions available for countries and regions

You can now define subregions, including states and provinces, within countries or regions to enforce consistency and data integrity and implement compliance measures at a granular level.

The states of the United States and the provinces of Canada are out-of-the-box subregions. You can create subregions for other countries or regions as needed. For more information, see Manage countries, regions, and subregions.

Billing connector for Salesforce CPQ available for early adopters

The CPQ Connector seamlessly integrates Salesforce CPQ with Zuora's backend, optimizing sales-to-billing-to-revenue workflows and enhancing operational efficiency. Synchronizing Salesforce CPQ data seamlessly integrates Accounts, Orders, Subscriptions, Contracts, and Quotes with Zuora objects, ensuring smooth downstream processes.

Enhanced data mapping flexibility for seamless integration

Previously, you could only map custom fields of the text type in Zuora. The latest update of Salesforce CPQ has eliminated this limitation, enabling seamless mapping of custom fields between the platforms regardless of their data type. This flexibility in data mapping extends to all supported objects, improving extensibility and customization capabilities.

Efficient streamlining of contact sync process

In account sync processes, Zuora will now exclusively synchronize relevant contacts from Salesforce CPQ accounts and orders. Syncing in Zuora will be limited to billing and shipping addresses designated as Bill To and Sold To contacts. Additionally, the connector will automatically generate contacts associated with orders during syncing.

Bill cycle default enhancement for subscriptions

The Salesforce CPQ connector now ensures accurate billing by defaulting the Bill Cycle to Charge Trigger Day on all subscriptions. This proactive approach eliminates partial billing periods, thereby preventing potential discrepancies in billing within Zuora. This modification ensures that charges can be evenly spread across multiple invoices, improving billing accuracy and alignment. For more information, see the specific month's list price.

Enhanced email alerts for improved notification

Email alerts for failures now provide more pertinent information, including details such as the object to sync, object ID, tenant ID, Zuora environment, and Salesforce environment. This enhancement aims to facilitate troubleshooting processes.

Enhanced system health logs

The Task Name field in System Health logs has been improved to display a combination of the synced object and its object ID. This enhancement simplifies the process of locating relevant logs for easier troubleshooting.

New System Health dashboard available

We have now released the following dashboard:

System Health dashboard	Description
E-Invoice	The E-Invoice dashboard collects and displays data about e-invoicing usage, failure, and transactions being processed in near real-time. You can leverage this dashboard to identify and troubleshoot e-invoicing issues.

For the initial few days, only 30 days of data are available.

Long Text custom field type available for standard and custom objects

The Long Text custom field type is now available for custom objects and the following standard objects:

• Account
• Credit Memo
• Debit Memo
• Invoice
• Payment
• Product
• Product Rate Plan
• Product Rate Plan Charge
• Refund
• Subscription
• Subscription Rate Plan
• Subscription Rate Plan Charge
• Usage

The maximum length limit of the Long Text type is from 256 to 8,192 characters.

The newly introduced Long Text custom field type and the existing Text custom field type both store string values. To differentiate these two types, we adjust the maximum length limit of the Text type from 8,192 to 255 characters.

The following table describes the details of the Text and Long Text types before and after this release:

Field type	Before	After
Text	If the field was filterable, the maximum length limit was 512 characters. If the field was not filterable, the maximum length limit was 8,192 characters.	The maximum length limit is 255 characters, regardless of whether the field is filterable.
Long Text	(N/A)	The maximum length limit is from 256 to 8,192 characters.

Note that after this release, existing Text custom fields whose Max Length setting is greater than 255 will be auto-converted to Long Text custom fields that are not filterable.

For more information, see Custom field types and settings.

New field updates to Zuora Secure Data Share for Snowflake objects

We have updated the Object definitions for Zuora Secure Data Share for Snowflake for better alignment with the latest data query object definitions. This update addresses discrepancies identified in the past including missing tables and fields in the Snowflake object definitions.

The new field updates to Zuora Secure Data Share for Snowflake objects are listed below:

Object	New Fields
CreditTaxationItem	periodenddate, periodstartdate, taxableamount
DebitTaxationItem	periodenddate, periodstartdate, taxableamount
Orders	category, errorcode, errormessage, invoicescheduleid, isreverting, response, reverteddate, revertedorderid, revertedordernumber, revertingorderid, scheduleddate, scheduleddatepolicy
Taxationitem	periodenddate, periodstartdate, taxableamount
Billingrun	invoicedatedayofmonth, invoicedatemonthoffset, targetdatedayofmonth, targetdatemonthoffset

Inactivating custom scheduled events on Central Sandbox refreshes

When Central Sandbox refreshes are completed, Zuora now marks custom scheduled events as inactive, aligning with the actual status of the events.

Previously, custom scheduled events were marked as active on refreshes.

 Back to Table of Contents