Skip to main content

API Versioning

Zuora

API Versioning

  1. Last updated
  2. Save as PDF

Zuora’s API versioning gives system administrators and developers centralized control over how API requests are processed in their tenants. As the Zuora API evolves, new versions introduce additional features, improvements, or behavior changes that may not be fully compatible with older integrations.

The API Versioning admin setting allows each tenant to lock in a specific API version. This setting determines the default behavior for all API requests made to that tenant. At the same time, developers can override this tenant-level setting on a per-request basis by including a Zuora-Version header in API calls.

Before upgrading to the latest version, you should review and incorporate any backward-incompatible changes that might affect your integration. Upgrading the API version changes the default way Zuora interprets and responds to API requests in a tenant. Once the default API version is upgraded at the tenant level, any request sent without a Zuora-Version header is automatically processed under this default version. 

The Roll Back button allows you to restore your tenant to its previous version. In the case that you have upgraded multiple times and have multiple previous versions, the rollback operation will roll back to only your last version and cannot be repeated infinitely.

Zuora recommends that you keep up to date with the latest API version to take advantage of the latest Zuora capabilities. 

See the following Developer Center pages for more information: