> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: 8acae0f7-a34a-439d-af3f-5dfaf5e68d24
---
# Settings API | Currencies
> Learn more about the currencies API endpoints to view and update your account's currencies and exchange rates.
export const PostmanCard = ({title, collectionId}) => {
return
} />
;
};
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
;
};
With the currencies API, you can manage the currencies used in your HubSpot account, including setting your account's company currency, creating additional currencies, and updating currency exchange rates. Learn more about [adding and editing currencies within HubSpot.](https://knowledge.hubspot.com/account-management/add-and-edit-your-account-currencies)
## Supported currencies
Only certain currencies are supported for use in HubSpot. To retrieve a list of HubSpot's supported currencies and their codes, make a `GET` request to `/settings/v3/currencies/codes`.
You can use any of the returned codes as values for the `currencyCode`, `fromCurrencyCode`, and `toCurrencyCode` properties.
## Add account currencies and set exchange rates
Depending on your HubSpot subscription, you can add additional currencies for use in your account, and set their exchange rates compared to your company currency. Learn more about the number of currencies you can have in your account in the [HubSpot Product & Services Catalog.](https://legal.hubspot.com/hubspot-product-and-services-catalog)
To add a currency and set the exchange rate, or add a new exchange rate for an existing currency, make a `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`).
You can also include a timestamp using the following field:
* `effectiveAt`: the date and time the exchange rate takes effect. Values can be in either [long date](https://www.jarte.com/help_new/date_and_time_formats.html) or [ISO 8601](https://developers.hubspot.com/docs#timestamps) format.
For example, your request may look like:
```json theme={null}
{
"fromCurrencyCode": "EUR",
"conversionRate": "1.3",
"effectiveAt": "2023-05-08T14:59:19.813Z"
}
```
To add multiple currencies and set their exchange rates in bulk, make a `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:
```json theme={null}
{
"inputs": [
{
"fromCurrencyCode": "USD",
"conversionRate": 2.7
},
{ "fromCurrencyCode": "EUR", "conversionRate": 1.3 }
]
}
```
## Retrieve account currencies and exchange rates
You can view your account's current and historical currencies and exchange rates.
To view your account's company currency, make a `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.
## Update your account's company currency
Your account's [company currency](https://knowledge.hubspot.com/account-management/add-and-edit-your-account-currencies#company-currency) is the currency used in deal amount totals, deal reports, and when creating new deals in HubSpot.
To update your account's company currency, make a `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:
```json theme={null}
{
"currencyCode": "AED"
}
```
**Please note:**
For accounts with multiple currencies, the company currency will have an automatically generated self-referencing rate (e.g., EUR/EUR=1.0). This rate is not modifiable via API.
## Update currency exchange rates
Once currencies are set up in your HubSpot account, you can update their exchange rates. To update an individual exchange rate, make a `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:
```json theme={null}
{
"conversionRate": 2
}
```
To update multiple currencies, make a `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:
```json theme={null}
{
"inputs": [
{
"id": "string",
"conversionRate": 1.3
},
{
"id": "string",
"conversionRate": 2
}
]
}
```
## Hide a currency
You can hide a currency so that it's not visible in your HubSpot account. To hide an existing account currency, make a `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`.
To hide a currency, your request may look like:
```json theme={null}
{
"fromCurrencyCode": "USD",
"toCurrencyCode": "AED",
"visibleInUI": false
}
```
## Limits and scopes
The daily limit for creating exchanges rates is 1,000. This is a total limit which includes rates created both individually and in batches.
There are different scopes that a users needs in order to view or edit currency and exchange rate data:
* `multi-currency-read`: required to retrieve and read currency data.
* `multi-currency-write`: required to edit currency data.
## Manage currencies with automatic exchange rate updates
If you’ve turned on [automatic exchange rate updates](https://knowledge.hubspot.com/account-management/automatic-exchange-rate-updates), you can use the currencies API to check if an account has automatic updates turned on, add new currencies with automatic exchange rate updates, and view currencies for which automatic exchange rate updates are not supported.
**Please note:**
The following behavior and endpoints only apply if you’ve [turned on the *Schedule automatic exchange rate updates* setting.](https://knowledge.hubspot.com/account-management/automatic-exchange-rate-updates#manage-automatic-exchange-rate-update-settings)
### Behavior changes for existing currency endpoints
Once you’ve turned on the automatic exchange rate updates setting, the following behavior is expected:
* **Changing company currency** (`PUT` `/company-currency`): If you change your company currency to an [unsupported currency](/api-reference/legacy/account/brands/guide#retrieve-unsupported-currencies), the automatic exchange rate setting will be turned off.
* **Fetching exchange rates** (`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.
* **Manually creating or updating exchange rates** (`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](/api-reference/legacy/account/brands/guide#retrieve-unsupported-currencies).
### Check if your account has turned on automatic exchange rate updates
To check if automatic exchange rate updates are enabled for your account, make a `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`.
```json theme={null}
{
"centralExchangeRatesEnabled": true
}
```
### Add a currency with automatic exchange rate updates
To add a currency with automatic updates enabled, make a `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:
```json theme={null}
{
"currencyCode": "USD"
}
```
### Retrieve unsupported currencies
To verify if a currency is supported for automatic exchange rate updates, make a `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.](/api-reference/legacy/account/brands/guide#update-currency-exchange-rates)