openapi: 3.0.1
info:
  title: HubSpot Settings Tax Rates
  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
paths:
  /tax-rates/2026-09/tax-rates:
    get:
      tags:
      - Basic
      summary: Get all tax rates
      description: Retrieve a paginated list of all tax rates set up in the account tax rate library
      operationId: get-/tax-rates/2026-09/tax-rates
      parameters:
      - name: active
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - 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: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponsePublicTaxRateGroupForwardPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - cpq.quotes.write
      - oauth2:
        - crm.objects.quotes.read
      - oauth2:
        - tax_rates.read
      - oauth2:
        - crm.objects.quotes.write
      - oauth2:
        - cpq.quotes.read
  /tax-rates/2026-09/tax-rates/{taxRateGroupId}:
    get:
      tags:
      - Basic
      summary: Get a specific tax rate
      description: Retrieve a specific tax rate by its `taxRateGroupId`.
      operationId: get-/tax-rates/2026-09/tax-rates/{taxRateGroupId}
      parameters:
      - name: taxRateGroupId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicTaxRateGroup'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - cpq.quotes.write
      - oauth2:
        - crm.objects.quotes.read
      - oauth2:
        - tax_rates.read
      - oauth2:
        - crm.objects.quotes.write
      - oauth2:
        - cpq.quotes.read
components:
  schemas:
    CollectionResponsePublicTaxRateGroupForwardPaging:
      required:
      - results
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ForwardPaging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/PublicTaxRateGroup'
    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.
    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
    PublicTaxRateGroup:
      required:
      - active
      - createdAt
      - id
      - label
      - name
      - percentageRate
      - updatedAt
      type: object
      properties:
        active:
          type: boolean
          description: Indicates whether the tax rate group is currently active.
        createdAt:
          type: string
          description: The date and time when the tax rate was created.
          format: date-time
        id:
          type: string
          description: The unique identifier for the tax rate.
        label:
          type: string
          description: The display label for the tax rate.
        name:
          type: string
          description: The name of the tax rate.
        percentageRate:
          type: number
          description: The percentage rate applied.
        updatedAt:
          type: string
          description: The date and time when the tax rate was last updated.
          format: date-time
  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: ''
    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