convertCurrency( )

Returns an array of amounts converted from the original (from) currency to the target (to) currency and the timestamp for the conversion rate used.

Use the convertCurrency() function to convert an array of one or more amounts between two currencies. The convertCurrency() function returns an array of converted amounts and the timestamp for the conversion rate used.

Note: The currency codes used must exist in the array of supported currencies returned by the listCurrencies() function.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Currencies
Manage Stores - all permissions
Learn more about permission scopes.
Method Declaration
Method Parameters

Identifying details needed to determine which currency rate to convert. The combination of the from and to properties together comprise the unique ID.


Amounts to convert.

Return Type:Promise<ConvertCurrencyResponse>
Was this helpful?