Sign in
Custom Exchange Rates

List custom exchange rates by currency

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

This reference describes how to query custom foreign exchange rates from Zuora. You can use this API method to query exchange rates only if you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action.

get/v1/custom-exchange-rates/{currency}

Path parameters

currencystring required

The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency.

The value must be a three-letter currency code, for example, USD.

Query parameters

startDatestring required

Start date of the date range for which you want to get exchange rates.

The date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date.

endDatestring required

End date of the date range for which you want to get exchange rates.

The date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

inverseboolean
  • If true, the exchange rate in the response is an inverse exchange rate.
  • If false, the exchange rate in the response is not an inverse exchange rate. The value is determined by the Use inverse rate checkbox in your Zuora Finance Manage Currency Conversion settings.
rateSetNamestring

The name of the exchange rate set.

You can specify the exchange rate set only when Exchange Rate Set permission is available. To enable the Exchange Rate Set option, submit a request at Zuora Global Support.

ratesobject

Container for exchange rate data. Contains a set of fields that provide exchange rate data for each day between the specified startDate and endDate (inclusive).

successboolean

Returns true if the request was processed successfully.

Changes