Skip to main content
Schema2020-08-27object

tax_rate

Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

TaxRate

object

Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).

active boolean
required

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.

country string
optionalnullable

Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

description string
optionalnullable

An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

display_name string
required

The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

id string
required

Unique identifier for the object.

inclusive boolean
required

This specifies if the tax rate is inclusive or exclusive.

jurisdiction string
optionalnullable

The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata object
optionalnullable

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

String representing the object's type. Objects of the same type share the same value.

percentage number
required

This represents the tax rate percent out of 100.

state string
optionalnullable

[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.

tax_type string
optionalnullable

The high-level tax type, such as `vat` or `sales_tax`.