Attributes
- idstring
Unique identifier for the object.
- activeboolean
Defaults to
true
. When set tofalse
, 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. - countrynullable string
Two-letter country code (ISO 3166-1 alpha-2).
- descriptionnullable string
An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
- display_
namestring The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
- inclusiveboolean
This specifies if the tax rate is inclusive or exclusive.
- jurisdictionnullable string
The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
- metadatanullable object
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.
- percentagefloat
Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
- statenullable string
ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.
More attributes
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- effective_
percentagenullable float Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
- flat_
amountnullable object The amount of the tax rate when the
rate_
istype flat_
. Tax rates withamount rate_
type percentage
can vary based on the transaction, resulting in this field beingnull
. This field exposes the amount and currency of the flat tax rate.- flat_amount.
amountinteger Amount of the tax when the
rate_
istype flat_
. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).amount - flat_amount.
currencystring Three-letter ISO currency code, in lowercase.
- jurisdiction_
levelnullable enum The level of the jurisdiction that imposes this tax rate. Will be
null
for manually defined tax rates.Possible enum valuescity
country
county
district
multiple
state
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - rate_
typenullable enum Indicates the type of tax rate applied to the taxable amount. This value can be
null
when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.Possible enum valuesflat_
amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.
percentage
A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.
- tax_
typenullable enum The high-level tax type, such as
vat
orsales_
.tax Possible enum valuesamusement_
tax Amusement Tax
communications_
tax Communications Tax
gst
Goods and Services Tax
hst
Harmonized Sales Tax
igst
Integrated Goods and Services Tax
jct
Japanese Consumption Tax
lease_
tax Chicago Lease Tax
pst
Provincial Sales Tax
qst
Quebec Sales Tax
retail_
delivery_ fee Retail Delivery Fee
Show 4 more
{ "id": "txr_1MzS4RLkdIwHu7ixwvpZ9c2i", "object": "tax_rate", "active": true, "country": null, "created": 1682114687, "description": "VAT Germany", "display_name": "VAT", "inclusive": false, "jurisdiction": "DE", "livemode": false, "metadata": {}, "percentage": 16, "state": null, "tax_type": null}