# tax\_rate

From **Stripe API**.

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).

- Type: `object`

## Properties

### `active`

- Required: true
- Type: `boolean`

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`

- Required: false
- Type: `string`
- Nullable: true
- maxLength: `5000`

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

### `created`

- Required: true
- Type: `integer`
- Format: `unix-time`

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

### `description`

- Required: false
- Type: `string`
- Nullable: true
- maxLength: `5000`

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

### `display_name`

- Required: true
- Type: `string`
- maxLength: `5000`

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`

- Required: true
- Type: `string`
- maxLength: `5000`

Unique identifier for the object.

### `inclusive`

- Required: true
- Type: `boolean`

This specifies if the tax rate is inclusive or exclusive.

### `jurisdiction`

- Required: false
- Type: `string`
- Nullable: true
- maxLength: `5000`

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`

- Required: true
- Type: `boolean`

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

### `metadata`

- Required: false
- Type: `object`
- Nullable: true

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`

- Required: true
- Type: `string`
- Allowed values: `"tax_rate"`

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

### `percentage`

- Required: true
- Type: `number`

This represents the tax rate percent out of 100.

### `state`

- Required: false
- Type: `string`
- Nullable: true
- maxLength: `5000`

[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`

- Required: false
- Type: `string`
- Nullable: true
- Allowed values: `"gst"`, `"hst"`, `"jct"`, `"pst"`, `"qst"`, `"rst"`, `"sales_tax"`, `"vat"`

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

## JSON Schema

```json
{"description":"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.\n\nRelated guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).","properties":{"active":{"description":"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.","type":"boolean"},"country":{"description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","maxLength":5000,"nullable":true,"type":"string"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"description":{"description":"An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.","maxLength":5000,"nullable":true,"type":"string"},"display_name":{"description":"The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.","maxLength":5000,"type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"inclusive":{"description":"This specifies if the tax rate is inclusive or exclusive.","type":"boolean"},"jurisdiction":{"description":"The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.","maxLength":5000,"nullable":true,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"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.","nullable":true,"type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["tax_rate"],"type":"string"},"percentage":{"description":"This represents the tax rate percent out of 100.","type":"number"},"state":{"description":"[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.","maxLength":5000,"nullable":true,"type":"string"},"tax_type":{"description":"The high-level tax type, such as `vat` or `sales_tax`.","enum":["gst","hst","jct","pst","qst","rst","sales_tax","vat"],"nullable":true,"type":"string"}},"required":["active","created","display_name","id","inclusive","livemode","object","percentage"],"title":"TaxRate","type":"object","x-expandableFields":[],"x-resourceId":"tax_rate"}
```