HubSpot: Currencies schemas

← Currencies operations · All schemas

Add a new currency with central exchange rates — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
currencyCode	string	Required within parent	The currency code being added to the HubSpot portal for use with central exchange rates. One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL

Add a new exchange rate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
conversionRate	number	Required within parent	The conversion rate between the to and from currency code of this exchange rate.
effectiveAt	string	Optional	The date the exchange rate is in effect. Format: date-time
fromCurrencyCode	string	Required within parent	This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert from. One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL

Add a new exchange rate — response body

Field	Type	Presence	Description and constraints
$	object	Root
conversionRate	JSON	Required within parent
conversionRate (anyOf 1)	number	Alternative	The conversion rate between the to and from currency code of this exchange rate.
conversionRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Required within parent	The date the exchange rate was created. Format: date-time
effectiveAt	string	Required within parent	The date the exchange rate is in effect. Format: date-time
fromCurrencyCode	string	Required within parent	This represents the three-letter currency code (such as USD for US Dollar) of the currency you are converting from. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL
id	string	Required within parent	A unique identifier for the exchange rate
toCurrencyCode	string	Required within parent	This represents the three-letter currency code (such as USD for US Dollar) of the currency you are converting to. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL
updatedAt	string	Required within parent	The date the exchange rate was last updated. Format: date-time
visibleInUI	boolean	Required within parent	This indicates if the exchange rate is shown in the MultiCurrency settings page.

Change the visibility of a specific currency pairs — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
fromCurrencyCode	string	Required within parent	This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert from. One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL
toCurrencyCode	string	Required within parent	This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert to. One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL
visibleInUI	boolean	Required within parent	This indicates if the currency pair is shown in the MultiCurrency settings page. Setting this to false will remove the currency pair from the settings page.

Create multiple exchange rates — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of ExchangeRateCreateRequest objects, each representing the details required to create a single exchange rate. This includes properties like fromCurrencyCode, conversionRate, and effectiveAt.
inputs[]	Model	Each item	Expand Add a new exchange rate — request body — body

Referenced models: Add a new exchange rate — request body — body

Get all currency codes — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of currency code information objects, each containing details about a specific currency code and its name.
results[]	Model	Each item	Expand Get all currency codes — response body — results item

Referenced models: Get all currency codes — response body — results item

Get all currency codes — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
currencyCode	string	Required within parent	The three-letter code representing a specific currency (ex. USD).
currencyName	string	Required within parent	The full name of the currency (ex. US Dollar).

Get all current exchange rates — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of exchange rate objects, each representing the conversion rate details between two currencies.
results[]	Model	Each item	Expand Add a new exchange rate — response body

Referenced models: Add a new exchange rate — response body

Get exchange rates — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Get all tax rates — response body — paging
results	array	Required within parent	An array of exchange rate objects, each representing a specific currency conversion rate.
results[]	Model	Each item	Expand Add a new exchange rate — response body

Referenced models: Get all tax rates — response body — paging, Add a new exchange rate — response body

Get the company currency — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date the company currency was created. Format: date-time
id	string	Required within parent	The currency code for the company currency

Retrieve information about the central exchange rates feature — response body

Field	Type	Presence	Description and constraints
$	object	Root
centralExchangeRatesEnabled	boolean	Required within parent	Indicates if central exchange rates is enabled for the portal or not.

Retrieve multiple rates — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicObjectId objects. Each object contains an ID string representing a unique identifier for a public object. This property is required.
inputs[]	Model	Each item	Expand Retrieve multiple rates — request body — body inputs item

Referenced models: Retrieve multiple rates — request body — body inputs item

Retrieve multiple rates — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	A unique identifier for the exchange rate

Retrieve multiple rates — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	The main category of the error.
context	object	Required within parent	Additional context-specific information related to the error. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	The detailed error objects.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A unique ID for the error instance.
links	object	Required within parent	URLs linking to documentation or resources associated with the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A human-readable string describing the error and possible remediation steps.
status	string	Required within parent	The HTTP status code associated with the error.
subCategory	object	Optional	A more specific error category within each main category.

Referenced models: Batch insert events — response body — errors item errors item

Retrieve multiple rates — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Exchange Rate

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The datetime the response was completed Format: date-time
links	object	Optional	The link to the next page with exchange rates. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The datetime the of the request. Format: date-time
results	array	Required within parent	An array of exchange rate objects that represent the results of the batch operation.
results[]	Model	Each item	Expand Add a new exchange rate — response body
startedAt	string	Required within parent	The datetime the of the request. Format: date-time
status	string	Required within parent	The current status of the response (e.g. COMPLETED) Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Add a new exchange rate — response body

Retrieve multiple rates — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Exchange Rate With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The datetime the response was completed Format: date-time
errors	array	Optional	An array of standard error objects detailing any errors encountered during the batch operation.
errors[]	Model	Each item	Expand Retrieve multiple rates — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	The link to the next page with exchange rates. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors associated to the request. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The datetime the of the request. Format: date-time
results	array	Required within parent	An array of exchange rate objects representing the successful results of the batch operation.
results[]	Model	Each item	Expand Add a new exchange rate — response body
startedAt	string	Required within parent	The datetime the of the request. Format: date-time
status	string	Required within parent	The current status of the response (e.g. COMPLETED) Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Retrieve multiple rates — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Add a new exchange rate — response body

Set or update the company currency — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
currencyCode	string	Required within parent	The three-letter code representing a specific currency (ex. USD). One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL

Update a conversion rate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
conversionRate	number	Required within parent	The updated conversion rate between the to and from currency code of this exchange rate.
effectiveAt	string	Optional	The date the exchange rate is in effect. Format: date-time

Update multiple exchange rates — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of ExchangeRateUpdateRequest objects, each representing an individual exchange rate update. This array is required and contains the details of each exchange rate to be updated, including the conversion rate and the effective date.
inputs[]	Model	Each item	Expand Update multiple exchange rates — request body — body inputs item

Referenced models: Update multiple exchange rates — request body — body inputs item

Update multiple exchange rates — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
conversionRate	number	Required within parent	The updated conversion rate between the to and from currency code of this exchange rate.
effectiveAt	string	Optional	The date the exchange rate will be in effect. Format: date-time
id	string	Required within parent	A unique identifier for the exchange rate being updated