BigCommerce · Schema

Tax_RatePOST

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
class_rates	array	Tax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.
enabled	boolean	Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.
name	string	The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings.
priority	integer	Allows for compounding tax rates, common in certain jurisdictions.
tax_zone_id	integer	ID of an associated tax zone. You must associate a tax rate with a tax zone.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Tax_RatePOST",
  "title": "Tax_RatePOST",
  "type": "object",
  "properties": {
    "class_rates": {
      "type": "array",
      "description": "Tax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.",
      "items": {
        "type": "object",
        "properties": {
          "rate": {
            "type": "number",
            "description": "The tax rate that you apply to the items in a tax class.",
            "example": 5
          },
          "tax_class_id": {
            "type": "integer",
            "description": "ID of a tax class. You must associate a tax rate with a tax class. The rate will apply to all items in this tax class.",
            "example": 1
          }
        },
        "required": [
          "rate",
          "tax_class_id"
        ]
      }
    },
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.",
      "default": true
    },
    "name": {
      "type": "string",
      "description": "The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings.",
      "example": "Sales Tax"
    },
    "priority": {
      "type": "integer",
      "description": "Allows for compounding tax rates, common in certain jurisdictions.",
      "default": 1
    },
    "tax_zone_id": {
      "type": "integer",
      "description": "ID of an associated tax zone. You must associate a tax rate with a tax zone.",
      "example": 2
    }
  },
  "required": [
    "class_rates",
    "name",
    "tax_zone_id"
  ]
}