[ Web Proxy ]
URL:
Viewing: https://docs.stripe.com/api/tax_rates [Back]  [Original]

Tax Rates | Stripe API Reference
Find anything
/
Ask AI

Tax Rates

Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.

Related guide: Tax rates

Was this section helpful?YesNo
Create a tax rate
POST/v1/tax_rates
Update a tax rate
POST/v1/tax_rates/:id
Retrieve a tax rate
GET/v1/tax_rates/:id
List all tax rates
GET/v1/tax_rates

The Tax Rate object

Attributes

  • idstring

    Unique identifier for the object.

  • activeboolean

    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.

  • 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 customers invoice.

  • metadatanullable map

    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.

  • percentagenumber

    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
Expand all

  • objectstring

  • createdtimestamp

  • effective_percentagenullable number

  • flat_amountnullable object

  • jurisdiction_levelnullable enum

  • livemodeboolean

  • rate_typenullable enum

  • tax_typenullable enum

The Tax Rate object
{
"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
}

Create a tax rate

POST/v1/tax_rates

Creates a new tax rate.

Parameters

  • display_namestringRequired

    The display name of the tax rate, which will be shown to users.

    The maximum length is 50 characters.

  • inclusivebooleanRequired

    This specifies if the tax rate is inclusive or exclusive.

  • percentagenumberRequired

    This represents the tax rate percent out of 100.

  • activeboolean

    Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

  • countrystring

    Two-letter country code (ISO 3166-1 alpha-2).

  • descriptionstring

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

  • jurisdictionstring

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

    The maximum length is 50 characters.

  • metadatamap

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • statestring

    ISO 3166-2 subdivision code, without country prefix. For example, NY for New York, United States.

More parameters
Expand all

  • tax_typeenum

Returns

The created tax rate object.

curl https://api.stripe.com/v1/tax_rates \
-u "sk_test_wU7nrJCZspk1NPDxiQgAF05qsk_test_wU7nrJCZspk1NPDxiQgAF05q:" \
-d display_name=VAT \
-d "description=VAT Germany" \
-d percentage=16 \
-d jurisdiction=DE \
-d inclusive=false
Response
{
"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
}

Web Proxy Viewer  |  New URL  |  Original Page