Learn more about the currencies API endpoints to view and update your account’s currencies and exchange rates.
GET
request to /settings/v3/currencies/codes
.
You can use any of the returned codes as values for the currencyCode
, fromCurrencyCode
, and toCurrencyCode
properties.
POST
request to /settings/v3/currencies/exchange-rates
. In your request, the following fields are required:
fromCurrencyCode
: the currency code of the currency you want to add to your account. This must be one of HubSpot’s supported currency codes.conversionRate
: the exchange rate from the additional currency to your company currency. The value must be greater than 0 and can contain up to 6 decimal values (e.g., 1.36
). Any values with more than 6 decimal places will be rounded (e.g., 1.2345678
becomes 1.234568
).effectiveAt
: the date and time the exchange rate takes effect. Values can be in either long date or ISO 8601 format.POST
request to /settings/v3/currencies/exchange-rates/batch/create
. Your request must include the fromCurrencyCode
and conversionRate
properties for each currency.
For example, your request may look like:
GET
request to /settings/v3/currencies/company-currency
. To view all of your account’s current currencies and exchange rates, make a GET
request to /settings/v3/currencies/exchange-rates/current
. When you make a successful request, the response will include the IDs of the exchange rates set in your account.
To view a specific currency and its exchange rate, make a GET
request to /settings/v3/currencies/exchange-rates/{exchangeRateId}
.
To view all of your account’s currencies and exchange rates, including historical currencies, make a GET
request to /settings/v3/currencies/exchange-rates
. You can filter which currencies and exchange rates are returned using the limit
, after
, fromCurrencyCode
and toCurrencyCode
query parameters in your request.
PUT
request to /settings/v3/currencies/company-currency
. In your request, include the currencyCode
value for the currency you want to set as your company currency. For example, your request may look like:
PATCH
request to /settings/v3/currencies/exchange-rates/{exchangeRateId}
. In your request, include the new exchange rate in the conversionRate
property. Your request may look like:
POST
request to /settings/v3/currencies/exchange-rates/batch/update
. In your request, include the exchange rate IDs and the new conversionRate
values. For example:
POST
request to /settings/v3/currencies/exchange-rates/update-visibility
. In your request, include the following:
fromCurrencyCode
: the code of the currency you want to hide or show.toCurrencyCode
: the code of your company currency.visibleInUI
: whether or not the currency and its exchange rate are shown in your HubSpot account. To hide a currency, the value should be false
. To show a previously hidden currency, set the value should be set to true
.multi-currency-read
: required to retrieve and read currency data.multi-currency-write
: required to edit currency data.PUT
/company-currency
): If you change your company currency to an unsupported currency, the automatic exchange rate setting will be turned off.GET
/exchange-rates
): When you retrieve all exchange rates, both manual and automatic updates to exchange rates will be returned. Changes to the company currency will not be returned. If you turn the automatic updates setting off after previously having it on, the exchange rate history will return manual updates to exchange rates and the synced rate effective at the time the setting was turned off.POST
/exchange-rates
, POST
/exchange-rates/batch/create
, PATCH
/exchange-rates
, and POST
/exchange-rates/batch/update
): Once automatic updates are turned on, supported currencies can only be updated by the automatic updates. You’ll only be able to manually add new currencies with exchange rates or update existing currency exchange rates for unsupported currencies.GET
request to settings/v3/currencies/central-fx-rates/information
.
If the setting is turned on, the centralExchangeRatesEnabled
field is returned with the value true
.
POST
request to settings/v3/currencies/central-fx-rates/add-currency
. In your request, include the currencyCode
for the new currency. You don’t need to include an exchange rate since the rate is automatically updated, powered by Open Exchange Rates, HubSpot’s third-party provider.
For example, to add the US dollar to your account with automatic exchange rate updates:
GET
request to settings/v3/currencies/central-fx-rates/unsupported-currencies
.
In the response, unsupported currencies are returned with their currencyCode
and currencyName
values. These currencies will always need manual exchange rate updates.