openapi: 3.0.1 info: title: HubSpot Settings Multicurrency description: Basepom for all HubSpot Projects version: 2026-09 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE servers: - url: https://api.hubapi.com tags: - name: Basic - name: Batch - name: Central FX rates - name: Exchange rates paths: /settings/currencies/2026-09/central-fx-rates/add-currency: post: tags: - Central FX rates summary: Add a new currency with central exchange rates. description: Create a new currency with central exchange rates in the portal. Unsupported currencies cannot be added here. operationId: post-/settings/currencies/2026-09/central-fx-rates/add-currency_/settings/v3/currencies/central-fx-rates/add-currency parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CurrencyCreateRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ExchangeRate' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - settings.currencies.write /settings/currencies/2026-09/central-fx-rates/information: get: tags: - Central FX rates summary: Retrieve information about the central exchange rates feature. description: Retrieve details on whether the central exchange rates feature is enabled for the portal. operationId: get-/settings/currencies/2026-09/central-fx-rates/information_/settings/v3/currencies/central-fx-rates/information parameters: [] responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CentralExchangeRatesInformation' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - cpq.quotes.write - oauth2: - crm.objects.quotes.read - oauth2: - settings.currencies.read - oauth2: - crm.objects.quotes.write - oauth2: - cpq.quotes.read /settings/currencies/2026-09/central-fx-rates/unsupported-currencies: get: tags: - Central FX rates summary: Retrieve currencies not supported by central exchange rates. description: Retrieve a list of currency codes that are not supported by the central exchange rates. Unsupported currencies will need to be manually updated. operationId: get-/settings/currencies/2026-09/central-fx-rates/unsupported-currencies_/settings/v3/currencies/central-fx-rates/unsupported-currencies parameters: [] responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CollectionResponseCurrencyCodeInfoNoPaging' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - cpq.quotes.write - oauth2: - crm.objects.quotes.read - oauth2: - settings.currencies.read - oauth2: - crm.objects.quotes.write - oauth2: - cpq.quotes.read /settings/currencies/2026-09/codes: get: tags: - Basic summary: Get all currency codes description: Retrieve a list of all available currency codes and their names. operationId: get-/settings/currencies/2026-09/codes parameters: [] responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CollectionResponseCurrencyCodeInfoNoPaging' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - cpq.quotes.write - oauth2: - crm.objects.quotes.read - oauth2: - settings.currencies.read - oauth2: - crm.objects.quotes.write - oauth2: - cpq.quotes.read /settings/currencies/2026-09/company-currency: get: tags: - Basic summary: Get the company currency description: Get the details for the company currency. The company currency is used in deal totals, reports, and the default currency for new deals. operationId: get-/settings/currencies/2026-09/company-currency parameters: [] responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CompanyCurrency' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - cpq.quotes.write - oauth2: - crm.objects.quotes.read - oauth2: - settings.currencies.read - oauth2: - crm.objects.quotes.write - oauth2: - cpq.quotes.read put: tags: - Basic summary: Set or update the company currency. description: Set or update the primary company currency. operationId: put-/settings/currencies/2026-09/company-currency parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyCurrencyUpdateRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CompanyCurrency' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - settings.currencies.write /settings/currencies/2026-09/exchange-rates: get: tags: - Exchange rates summary: Get exchange rates description: Get a list of exchange rates operationId: get-/settings/currencies/2026-09/exchange-rates parameters: - name: after in: query description: The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. required: false style: form explode: true schema: type: string - name: fromCurrencyCode in: query description: '' required: false style: form explode: true schema: type: string enum: - 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 - name: limit in: query description: The maximum number of results to display per page. required: false style: form explode: true schema: type: integer format: int32 default: 100 - name: toCurrencyCode in: query description: '' required: false style: form explode: true schema: type: string enum: - 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 responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CollectionResponseExchangeRateForwardPaging' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - cpq.quotes.write - oauth2: - crm.objects.quotes.read - oauth2: - settings.currencies.read - oauth2: - crm.objects.quotes.write - oauth2: - cpq.quotes.read post: tags: - Exchange rates summary: Add a new exchange rate description: Create a new exchange rate with specified conversion rate and currency codes. operationId: post-/settings/currencies/2026-09/exchange-rates parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ExchangeRateCreateRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ExchangeRate' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - settings.currencies.write /settings/currencies/2026-09/exchange-rates/batch/create: post: tags: - Batch summary: Create multiple exchange rates description: Create multiple exchange rates in a single request. operationId: post-/settings/currencies/2026-09/exchange-rates/batch/create parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchInputExchangeRateCreateRequest' required: true responses: '201': description: successful operation content: application/json: schema: $ref: '#/components/schemas/BatchResponseExchangeRate' '207': description: multiple statuses content: application/json: schema: $ref: '#/components/schemas/BatchResponseExchangeRateWithErrors' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - settings.currencies.write /settings/currencies/2026-09/exchange-rates/batch/read: post: tags: - Batch summary: Retrieve multiple rates description: Retrieve the details of multiple exchange rates in a single request, specified by their IDs. operationId: post-/settings/currencies/2026-09/exchange-rates/batch/read parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchInputPublicObjectId' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/BatchResponseExchangeRate' '207': description: multiple statuses content: application/json: schema: $ref: '#/components/schemas/BatchResponseExchangeRateWithErrors' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - cpq.quotes.write - oauth2: - crm.objects.quotes.read - oauth2: - settings.currencies.read - oauth2: - crm.objects.quotes.write - oauth2: - cpq.quotes.read /settings/currencies/2026-09/exchange-rates/batch/update: post: tags: - Batch summary: Update multiple exchange rates description: Update the conversion rates for multiple exchange rates in a batch operation. operationId: post-/settings/currencies/2026-09/exchange-rates/batch/update parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchInputExchangeRateUpdateRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/BatchResponseExchangeRate' '207': description: multiple statuses content: application/json: schema: $ref: '#/components/schemas/BatchResponseExchangeRateWithErrors' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - settings.currencies.write /settings/currencies/2026-09/exchange-rates/current: get: tags: - Exchange rates summary: Get all current exchange rates description: Retrieve all current exchange rates for all currency pairs. operationId: get-/settings/currencies/2026-09/exchange-rates/current parameters: [] responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CollectionResponseExchangeRateNoPaging' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - cpq.quotes.write - oauth2: - crm.objects.quotes.read - oauth2: - settings.currencies.read - oauth2: - crm.objects.quotes.write - oauth2: - cpq.quotes.read /settings/currencies/2026-09/exchange-rates/update-visibility: post: tags: - Exchange rates summary: Change the visibility of a specific currency pairs description: Change the visibility setting for a currency pair. This will hide or display a currency pair for users in the HubSpot app. operationId: post-/settings/currencies/2026-09/exchange-rates/update-visibility parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CurrencyPairUpdate' required: true responses: '204': description: No content content: {} default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - settings.currencies.write /settings/currencies/2026-09/exchange-rates/{exchangeRateId}: get: tags: - Exchange rates summary: Get the details for a specific exchange rate description: Retrieve the details for a specific exchange rate specified by its ID. operationId: get-/settings/currencies/2026-09/exchange-rates/{exchangeRateId} parameters: - name: exchangeRateId in: path description: '' required: true style: simple explode: false schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ExchangeRate' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - cpq.quotes.write - oauth2: - crm.objects.quotes.read - oauth2: - settings.currencies.read - oauth2: - crm.objects.quotes.write - oauth2: - cpq.quotes.read patch: tags: - Exchange rates summary: Update a conversion rate description: Update an existing conversion rate, specified by its ID. operationId: patch-/settings/currencies/2026-09/exchange-rates/{exchangeRateId} parameters: - name: exchangeRateId in: path description: '' required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExchangeRateMultiplier' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ExchangeRate' default: description: '' $ref: '#/components/responses/Error' security: - oauth2: - settings.currencies.write components: schemas: BatchInputExchangeRateCreateRequest: required: - inputs type: object properties: inputs: type: array items: $ref: '#/components/schemas/ExchangeRateCreateRequest' BatchInputExchangeRateUpdateRequest: required: - inputs type: object properties: inputs: type: array items: $ref: '#/components/schemas/ExchangeRateUpdateRequest' BatchInputPublicObjectId: required: - inputs type: object properties: inputs: type: array items: $ref: '#/components/schemas/PublicObjectId' BatchResponseExchangeRate: required: - completedAt - results - startedAt - status type: object properties: completedAt: type: string description: The datetime the response was completed format: date-time links: type: object additionalProperties: type: string description: The link to the next page with exchange rates. requestedAt: type: string description: The datetime the of the request. format: date-time results: type: array items: $ref: '#/components/schemas/ExchangeRate' startedAt: type: string description: The datetime the of the request. format: date-time status: type: string description: The current status of the response (e.g. COMPLETED) enum: - CANCELED - COMPLETE - PENDING - PROCESSING BatchResponseExchangeRateWithErrors: required: - completedAt - results - startedAt - status type: object properties: completedAt: type: string description: The datetime the response was completed format: date-time errors: type: array items: $ref: '#/components/schemas/StandardError' links: type: object additionalProperties: type: string description: The link to the next page with exchange rates. numErrors: type: integer description: The number of errors associated to the request. format: int32 requestedAt: type: string description: The datetime the of the request. format: date-time results: type: array items: $ref: '#/components/schemas/ExchangeRate' startedAt: type: string description: The datetime the of the request. format: date-time status: type: string description: The current status of the response (e.g. COMPLETED) enum: - CANCELED - COMPLETE - PENDING - PROCESSING CentralExchangeRatesInformation: required: - centralExchangeRatesEnabled type: object properties: centralExchangeRatesEnabled: type: boolean description: Indicates if central exchange rates is enabled for the portal or not. CollectionResponseCurrencyCodeInfoNoPaging: required: - results type: object properties: results: type: array items: $ref: '#/components/schemas/CurrencyCodeInfo' CollectionResponseExchangeRateForwardPaging: required: - results type: object properties: paging: $ref: '#/components/schemas/ForwardPaging' results: type: array items: $ref: '#/components/schemas/ExchangeRate' CollectionResponseExchangeRateNoPaging: required: - results type: object properties: results: type: array items: $ref: '#/components/schemas/ExchangeRate' CompanyCurrency: required: - createdAt - id type: object properties: createdAt: type: string description: The date the company currency was created. format: date-time id: type: string description: The currency code for the company currency CompanyCurrencyUpdateRequest: required: - currencyCode type: object properties: currencyCode: type: string description: The three-letter code representing a specific currency (ex. USD). enum: - 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 CurrencyCodeInfo: required: - currencyCode - currencyName type: object properties: currencyCode: type: string description: The three-letter code representing a specific currency (ex. USD). currencyName: type: string description: The full name of the currency (ex. US Dollar). CurrencyCreateRequest: required: - currencyCode type: object properties: currencyCode: type: string description: The currency code being added to the HubSpot portal for use with central exchange rates. enum: - 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 CurrencyPairUpdate: required: - fromCurrencyCode - toCurrencyCode - visibleInUI type: object properties: fromCurrencyCode: type: string description: This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert from. enum: - 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: type: string description: This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert to. enum: - 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: type: boolean description: 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. Error: required: - category - correlationId - message type: object properties: category: type: string description: The error category context: type: object additionalProperties: type: array items: type: string description: Context about the error condition example: '{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}' correlationId: type: string description: A unique identifier for the request. Include this value with any error reports or support tickets format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: further information about the error items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: A map of link names to associated URIs containing documentation about the error or recommended remediation steps message: type: string description: A human readable message describing the error along with remediation steps where appropriate example: An error occurred subCategory: type: string description: A specific category that contains more specific detail about the error description: Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base ErrorDetail: required: - message type: object properties: code: type: string description: The status code associated with the error detail context: type: object additionalProperties: type: array items: type: string description: Context about the error condition example: '{missingScopes=[scope1, scope2]}' in: type: string description: The name of the field or parameter in which the error was found. message: type: string description: A human readable message describing the error along with remediation steps where appropriate subCategory: type: string description: A specific category that contains more specific detail about the error description: Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response. ExchangeRate: required: - conversionRate - createdAt - effectiveAt - fromCurrencyCode - id - toCurrencyCode - updatedAt - visibleInUI type: object properties: conversionRate: type: number description: The conversion rate between the to and from currency code of this exchange rate. createdAt: type: string description: The date the exchange rate was created. format: date-time effectiveAt: type: string description: The date the exchange rate is in effect. format: date-time fromCurrencyCode: type: string description: This represents the three-letter currency code (such as USD for US Dollar) of the currency you are converting from. enum: - 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: type: string description: A unique identifier for the exchange rate toCurrencyCode: type: string description: This represents the three-letter currency code (such as USD for US Dollar) of the currency you are converting to. enum: - 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: type: string description: The date the exchange rate was last updated. format: date-time visibleInUI: type: boolean description: This indicates if the exchange rate is shown in the MultiCurrency settings page. ExchangeRateCreateRequest: required: - conversionRate - fromCurrencyCode type: object properties: conversionRate: type: number description: The conversion rate between the to and from currency code of this exchange rate. effectiveAt: type: string description: The date the exchange rate is in effect. format: date-time fromCurrencyCode: type: string description: This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert from. enum: - 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 ExchangeRateMultiplier: required: - conversionRate type: object properties: conversionRate: type: number description: The updated conversion rate between the to and from currency code of this exchange rate. effectiveAt: type: string description: The date the exchange rate is in effect. format: date-time ExchangeRateUpdateRequest: required: - conversionRate - id type: object properties: conversionRate: type: number description: The updated conversion rate between the to and from currency code of this exchange rate. effectiveAt: type: string description: The date the exchange rate will be in effect. format: date-time id: type: string description: A unique identifier for the exchange rate being updated ForwardPaging: type: object properties: next: $ref: '#/components/schemas/NextPage' description: Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page. NextPage: required: - after type: object properties: after: type: string description: A paging cursor token for retrieving subsequent pages. link: type: string description: A URL that can be used to retrieve the next page results. description: Specifies the paging information needed to retrieve the next set of results in a paginated API response PublicObjectId: required: - id type: object properties: id: type: string description: A unique identifier for the exchange rate description: Contains the Id of a Public Object StandardError: required: - category - context - errors - links - message - status type: object properties: category: type: string description: The main category of the error. context: type: object additionalProperties: type: array items: type: string description: Additional context-specific information related to the error. errors: type: array description: The detailed error objects. items: $ref: '#/components/schemas/ErrorDetail' id: type: string description: A unique ID for the error instance. links: type: object additionalProperties: type: string description: URLs linking to documentation or resources associated with the error. message: type: string description: A human-readable string describing the error and possible remediation steps. status: type: string description: The HTTP status code associated with the error. subCategory: type: object properties: {} description: A more specific error category within each main category. description: Ye olde error responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: developer_hapikey: type: apiKey name: hapikey in: query oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: cpq.quotes.write: '' settings.currencies.write: '' private_apps: type: apiKey name: private-app in: header private_apps_legacy: type: apiKey name: private-app-legacy in: header x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE