Retrieve a tax rate

Changed on

Retrieves a tax rate with the given ID

get/v1/tax_rates/{tax_rate}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/tax_rates/{tax_rate}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

tax_ratestring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

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

countrystring nullable

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

createdinteger required

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

descriptionstring nullable

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

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

effective_percentagenumber nullable

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.

idstring required

Unique identifier for the object.

inclusiveboolean required

This specifies if the tax rate is inclusive or exclusive.

jurisdictionstring nullable

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

jurisdiction_level'city' | 'country' | 'county' | 'district' | 'multiple' | 'state' nullable

The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

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.

object'tax_rate' required

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

percentagenumber required

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.

rate_type'flat_amount' | 'percentage' nullable

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.

statestring nullable

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

tax_type'amusement_tax' | 'communications_tax' | 'digital_excise_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'mass_transit_parking_tax' | 'parking_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'utility_users_tax' | 'vat' nullable

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

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.