Get Currency | BigCommerce Developer Center

Returns a single Currency.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

idstringRequired

Response

auto_updateboolean

Specifies whether to use the Open Exchange Rates service to update the currency conversion. A value of false specifies a static conversion value. auto_update only applies to non-transactional currencies.

country_iso2string

2-letter ISO Alpha-2 code for this currency’s country.

currency_codestring

3-letter ISO 4217 code for this currency.

currency_exchange_ratestring

Amount of this currency that is equivalent to one U.S. dollar.(Float, Float as String, Integer)

decimal_placesinteger

Number of decimal places to show for this currency.

decimal_tokenstring

Symbol used as the decimal separator in this currency.

default_for_country_codeslist of strings

Default 3-letter ISO 4217 code for this currency.

enabledboolean

If the currency is active on the store.

idintegerRead-only

ID of the currency. Read only.

is_defaultboolean

Specifies the store’s default currency display format. For write operations, only true value is accepted. When set to true, it cannot be unset, only overridden.

is_transactionalboolean

Indicates if the currency is set as transactional or not. False means display only currency

last_updateddatetimeRead-only

Date the currency was last updated, created or modified.

namestring

Name of the currency.

thousands_tokenstring

Symbol used as the thousands separator in this currency.

tokenstring

Symbol for this currency.

token_locationstring

Specifies whether this currency’s symbol appears to the “left” or “right” of the numeric amount.

use_default_nameboolean

Default currency name

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v2/currencies/id"
4
5	headers = {"X-Auth-Token": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"auto_update": true,
3	"country_iso2": "EU",
4	"currency_code": "EUR",
5	"currency_exchange_rate": "0.849",
6	"decimal_places": 2,
7	"decimal_token": ".",
8	"default_for_country_codes": [
9	"EU"
10	],
11	"enabled": false,
12	"id": 2,
13	"is_default": false,
14	"is_transactional": true,
15	"last_updated": "2024-01-15T09:30:00Z",
16	"name": "Euro",
17	"thousands_token": ",",
18	"token": "€",
19	"token_location": "left",
20	"use_default_name": false
21	}