BigCommerce · Schema

Tax Exempt (Order Level)

Use this to refund a custom value at the order level. When `item_type` is set to `ORDER`, tax is not re-calculated.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
item_type string The type of refund. When `item_type` is set to `ORDER`, tax is not re-calculated.
item_id number Numeric ID of the product in the order.
amount object
reason string Reason for the refund.
View JSON Schema on GitHub

JSON Schema

bigcommerce-taxexemptitem-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TaxExemptItem",
  "title": "Tax Exempt (Order Level)",
  "type": "object",
  "description": "Use this to refund a custom value at the order level. When `item_type` is set to `ORDER`, tax is not re-calculated.",
  "x-internal": false,
  "properties": {
    "item_type": {
      "type": "string",
      "description": "The type of refund. When `item_type` is set to `ORDER`, tax is not re-calculated.",
      "example": "ORDER",
      "enum": [
        "ORDER"
      ]
    },
    "item_id": {
      "type": "number",
      "description": "Numeric ID of the product in the order.",
      "example": 1
    },
    "amount": {
      "$ref": "#/components/schemas/Amount"
    },
    "reason": {
      "type": "string",
      "description": "Reason for the refund.",
      "minLength": 0,
      "maxLength": 1000
    }
  }
}