BigCommerce · Schema

currency_Base

Currency Object

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
is_default	boolean	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.
country_iso2	string	2-letter ISO Alpha-2 code for this currency’s country.
currency_code	string	3-letter ISO 4217 code for this currency.
currency_exchange_rate	string	Amount of this currency that is equivalent to one U.S. dollar.(Float, Float as String, Integer)
auto_update	boolean	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 currenci
token_location	string	Specifies whether this currency’s symbol appears to the “left” or “right” of the numeric amount.
token	string	Symbol for this currency.
decimal_token	string	Symbol used as the decimal separator in this currency.
thousands_token	string	Symbol used as the thousands separator in this currency.
decimal_places	integer	Number of decimal places to show for this currency.
name	string	Name of the currency.
enabled	boolean	If the currency is active on the store.
is_transactional	boolean	Indicates if the currency is set as transactional or not. False means display only currency

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/currency_Base",
  "title": "currency_Base",
  "required": [
    "currency_code",
    "currency_exchange_rate",
    "decimal_places",
    "decimal_token",
    "name",
    "thousands_token",
    "token",
    "token_location"
  ],
  "type": "object",
  "properties": {
    "is_default": {
      "type": "boolean",
      "description": "Specifies the store\u2019s default currency display format. For write operations, only true value is accepted. When set to true, it cannot be unset, only overridden.",
      "example": false
    },
    "country_iso2": {
      "type": "string",
      "description": "2-letter ISO Alpha-2 code for this currency\u2019s country.",
      "example": "EU"
    },
    "currency_code": {
      "type": "string",
      "description": "3-letter ISO 4217 code for this currency.",
      "example": "EUR"
    },
    "currency_exchange_rate": {
      "type": "string",
      "description": "Amount of this currency that is equivalent to one U.S. dollar.(Float, Float as String, Integer)",
      "example": "0.849"
    },
    "auto_update": {
      "type": "boolean",
      "description": "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.",
      "example": true
    },
    "token_location": {
      "type": "string",
      "description": "Specifies whether this currency\u2019s symbol appears to the \u201cleft\u201d or \u201cright\u201d of the numeric amount.",
      "example": "left"
    },
    "token": {
      "type": "string",
      "description": "Symbol for this currency.",
      "example": "\u20ac"
    },
    "decimal_token": {
      "type": "string",
      "description": "Symbol used as the decimal separator in this currency.",
      "example": "."
    },
    "thousands_token": {
      "type": "string",
      "description": "Symbol used as the thousands separator in this currency.",
      "example": ","
    },
    "decimal_places": {
      "type": "integer",
      "description": "Number of decimal places to show for this currency.",
      "example": 2
    },
    "name": {
      "type": "string",
      "description": "Name of the currency.",
      "example": "Euro"
    },
    "enabled": {
      "type": "boolean",
      "description": "If the currency is active on the store.",
      "example": false
    },
    "is_transactional": {
      "type": "boolean",
      "description": "Indicates if the currency is set as transactional or not. False means display only currency",
      "example": false
    }
  },
  "description": "Currency Object",
  "example": {
    "id": 2,
    "is_default": false,
    "last_updated": "Tue, 12 Jun 2018 14:41:56 +0000\"",
    "country_iso2": "EU",
    "currency_code": "EUR",
    "currency_exchange_rate": "0.849",
    "auto_update": true,
    "token_location": "left",
    "token": "\u20ac",
    "decimal_token": ".",
    "thousands_token": ",",
    "decimal_places": 2,
    "name": "Euro",
    "enabled": false
  },
  "x-examples": {
    "Example": {
      "value": {
        "country_iso2": "EU",
        "currency_code": "EUR",
        "currency_exchange_rate": "0.849",
        "auto_update": true,
        "token_location": "left",
        "token": "\u20ac",
        "decimal_token": ".",
        "thousands_token": ",",
        "decimal_places": 2,
        "name": "Euro",
        "is_transactional": false,
        "id": 2,
        "is_default": false,
        "last_updated": "2018-06-12 14:41:56+00:00",
        "enabled": false
      }
    }
  },
  "x-internal": false
}