BigCommerce · Schema

TaxProperty

A simple key value pairing allowing merchants to provide an additional input into a tax providerʼs tax calculation.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
code string Used by tax providers to programmatically identify a specific calculation input.
value string The value that will be factored into the tax providerʼs tax calculation rules, where supported.
View JSON Schema on GitHub

JSON Schema

bigcommerce-request-item-tax-property-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/request-item-tax-property",
  "title": "TaxProperty",
  "type": "object",
  "description": "A simple key value pairing allowing merchants to provide an additional input into a tax provider\u02bcs tax calculation.",
  "properties": {
    "code": {
      "type": "string",
      "description": "Used by tax providers to programmatically identify a specific calculation input.",
      "example": "alcohol-percentage"
    },
    "value": {
      "type": "string",
      "description": "The value that will be factored into the tax provider\u02bcs tax calculation rules, where supported.",
      "example": "4.9"
    }
  },
  "required": [
    "code",
    "value"
  ],
  "x-internal": false
}