Defines the object schema located at components.schemas.tax_rate in the specification.
Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
Related guide: Tax Rates.
Constructors
TaxRatetaxRateActive :: Boolactive: Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
taxRateCountry :: Maybe (Nullable Text)taxRateCreated :: Intcreated: Time at which the object was created. Measured in seconds since the Unix epoch.
taxRateDescription :: Maybe (Nullable Text)description: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
Constraints:
Maximum length of 5000
taxRateDisplayName :: Textdisplay_name: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
Constraints:
Maximum length of 5000
taxRateId :: Textid: Unique identifier for the object.
Constraints:
Maximum length of 5000
taxRateInclusive :: Boolinclusive: This specifies if the tax rate is inclusive or exclusive.
taxRateJurisdiction :: Maybe (Nullable Text)jurisdiction: The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
Constraints:
Maximum length of 5000
taxRateLivemode :: Boollivemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
taxRateMetadata :: Maybe (Nullable Object)metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
taxRatePercentage :: Doublepercentage: This represents the tax rate percent out of 100.
taxRateState :: Maybe (Nullable Text)state: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
Constraints:
Maximum length of 5000
taxRateTaxType :: Maybe (Nullable TaxRateTaxType'NonNullable)tax_type: The high-level tax type, such as `vat` or `sales_tax`.