Skip to main content

Zuora Billing Release 289, December 2020

Zuora

Zuora Billing Release 289, December 2020

Welcome to the release notes for Zuora Billing Release 289 (R289), December 2020

For more information about the release notes of other Zuora products, see Zuora Release Notes.

Release schedule

Subscribe to Release Notifications in Zuora Community to receive notifications about Zuora Billing releases.

REST API

See API Changelog for a summary of REST API updates and documentation updates in the API Reference: Billing.

Orders and Subscriptions

Limitation on the duration of subscription terms removed from Orders

As of Zuora Billing Release 289, Zuora has removed the 10-year limitation on the duration of subscription terms in Orders. Previously, the duration of the initial term or renewal term of a subscription could not be greater than 10 years.

Field name changes on the ChargeMetrics and ChargeMetricsDiscountAllocationDetail objects

For the consistency of field names across all objects, Zuora has changed the field name for each of the following fields on both the ChargeMetrics and ChargeMetricsDiscountAllocationDetail objects. 

  • Changed the field createdOn to CreatedDate
  • Changed the field updatedOn to UpdatedDate

Invoicing and Invoice Settlement

Attachment support for credit and debit memos

This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support

You can now use attachments in Zuora to upload documents of various formats to associate additional information with credit memos or debit memos through the Zuora UI and API. 

  • Through the Zuora UI: On the credit or debit memo details page, you can now click new attachment > choose file in the Attachments area to upload document files for the credit or debit memo. 
  • Through the API: You can use the Add attachments operation to attach document files for credit memos or debit memos.

See Attachments on Credit and Debit Memos for more information.

Support for automatic posting during memo creation through the REST API

This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support

When creating credit or debit memos through the REST API, you can also automatically post the memos by setting the autoPost field to true in the request body of the following operations:

Notifications available for refunding credit Memos

This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support

You can now create notifications on refunding credit memos for the Credit Memo Refund Processed event. After a credit memo is refunded, Zuora sends you a callout or email notification.

Change to the limit on the total number of items in invoice write-off or reversal

This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support

During invoice write-off or reversal through the Zuora UI or API, Zuora now changes the limit on the total number of items that can be contained in one invoice from 750 to 2,000.

You can only write off or reverse an invoice if it contains at most 2,000 items in total, including invoice items, discount items, and taxation items. If an invoice contains more than 750 items, see Invoice write-off and Invoice reversal for the workaround.

Credit amount enhancement for memos created from invoices

This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support

Zuora has enhanced the credit amount configuration for creating credit and debit memos from invoices.

If Tax Auto Calculation is selected on the Create Credit/Debit Memo page, you cannot input any credit amount in the Credit Amount column for taxation items.

Support for inputting reason codes and comments in invoice write-off

This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support

When writing off an invoice through the Zuora UI, you can now input a reason code in the Reason Code field and a comment in the Comment field in the displayed dialog. Both the reason code and comment are for the credit memo to be created.

See Write off invoices for more information.

Resolved: Post button unavailable in the expanded view of some bill runs

Previously on the All Bill Runs page, the Post button was not displayed in the expanded view for the bill runs that only generated credit memos.

This issue has been resolved. 

Payments

Ingenico ePayments now supports custom Merchant ID hierarchy

Zuora has enhanced the Ingenico ePayments gateway integration to support a custom Merchant ID hierarchy, which allows you to flexibly select the Merchant ID used in transaction requests when you have multiple Merchant IDs. With the custom Merchant ID hierarchy enabled, Zuora will search for and use the value for Merchant ID in the following order:

  • The merchantId gateway option field in API requests
  • The Merchant ID custom field created on the Payment object
  • The Merchant ID custom field created on the Account object 
  • The Merchant ID field on the gateway configuration page

See Ingenico ePayments gateway for more information.

GoCardless gateway integration now supports OAuth 2.0 authentication

The GoCardless gateway integration in Zuora now supports the OAuth 2.0 authentication. You can create an OAuth token in Zuora and use it as the credential to configure a GoCardless gateway instance. 

  • For new GoCardless gateway instances, you must use the created OAuth token as the credential.
  • For existing GoCardless gateway instances, the previously stored Access Token and Creditor ID credentials can continue to work, but cannot be updated anymore. We also provide you with the flexibility to switch to the OAuth authentication mode at any time.

See the following articles for more information:

SOAP API

Current WSDL version: 106

See Zuora WSDL for information on how to check your version and download the latest version.

SOAP API change history

See Zuora SOAP API Version History for a summary of updates made to the SOAP API in recent Zuora releases.