HistoricalTaxRateSnapshot

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/checkoutpage-com/json-schema/checkoutpage-com-historical-tax-rate-snapshot-schema.json",
  "title": "HistoricalTaxRateSnapshot",
  "description": "Tax rate values captured at the time of the transaction.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/checkoutpage-com-invoices-api-openapi.yml#/components/schemas/HistoricalTaxRateSnapshot",
  "properties": {
    "active": {
      "type": "boolean"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "default": {
      "type": "boolean"
    },
    "displayName": {
      "description": "The name of the tax rate. Used in the checkout and invoice.",
      "type": "string"
    },
    "inclusive": {
      "description": "Whether the tax rate is inclusive.",
      "type": "boolean"
    },
    "percentage": {
      "description": "The percentage of the tax rate.",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "stripeId": {
      "description": "The ID of the tax rate in Stripe at the time of the transaction.",
      "type": "string"
    },
    "taxRate": {
      "allOf": [
        {
          "$ref": "#/$defs/UniqueIdentifier"
        },
        {
          "description": "Tax rate ID this snapshot was taken from."
        }
      ]
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "taxRate",
    "stripeId",
    "displayName",
    "inclusive",
    "percentage"
  ],
  "type": "object",
  "$defs": {
    "UniqueIdentifier": {
      "description": "Unique identifier for the ticket.",
      "pattern": "^[0-9a-fA-F]{24}$",
      "type": "string"
    }
  }
}