Skip to main content

API Versioning

Zuora

API Versioning

  1. Last updated
  2. Save as PDF

The Zuora v1 API uses API versions to control backward-incompatible changes, such as deprecating a field on an object or replacing a parameter in a request. To use the version-controlled parameters or get version-controlled fields, you can specify the zuora-version request header to the version you want to use.

If no version is specified in the request header, Zuora uses the minimum version (186.0) of the v1 API by default. All requests will use your tenant API settings, unless you override the API version.

The API Versioning administration setting allows you to upgrade your tenant to the latest API version, or roll back to a previous version. You can see the current API version for your tenant and the latest API version. Before upgrading to the latest version, you should review and incorporate any backward-incompatible changes that might affect your integration.

Zuora recommends that you upgrade to the latest API version to take advantage of the latest Zuora capabilities. 

See the following Developer Center pages for more information: