TaxRate

Stripe 0.3.0, Aug 14 26

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

Create TaxRate Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TaxRate(name: string, args: TaxRateArgs, opts?: CustomResourceOptions);

@overload
def TaxRate(resource_name: str,
            args: TaxRateArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def TaxRate(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            display_name: Optional[str] = None,
            inclusive: Optional[bool] = None,
            percentage: Optional[float] = None,
            active: Optional[bool] = None,
            country: Optional[str] = None,
            description: Optional[str] = None,
            jurisdiction: Optional[str] = None,
            metadata: Optional[Mapping[str, str]] = None,
            state: Optional[str] = None,
            tax_type: Optional[str] = None)

func NewTaxRate(ctx *Context, name string, args TaxRateArgs, opts ...ResourceOption) (*TaxRate, error)

public TaxRate(string name, TaxRateArgs args, CustomResourceOptions? opts = null)

public TaxRate(String name, TaxRateArgs args)
public TaxRate(String name, TaxRateArgs args, CustomResourceOptions options)

type: stripe:TaxRate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "stripe_tax_rate" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args TaxRateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TaxRateArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TaxRateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TaxRateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TaxRateArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var taxRateResource = new Stripe.TaxRate("taxRateResource", new()
{
    DisplayName = "string",
    Inclusive = false,
    Percentage = 0.0,
    Active = false,
    Country = "string",
    Description = "string",
    Jurisdiction = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    State = "string",
    TaxType = "string",
});

example, err := stripe.NewTaxRate(ctx, "taxRateResource", &stripe.TaxRateArgs{
	DisplayName:  pulumi.String("string"),
	Inclusive:    pulumi.Bool(false),
	Percentage:   pulumi.Float64(0),
	Active:       pulumi.Bool(false),
	Country:      pulumi.String("string"),
	Description:  pulumi.String("string"),
	Jurisdiction: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	State:   pulumi.String("string"),
	TaxType: pulumi.String("string"),
})

resource "stripe_tax_rate" "taxRateResource" {
  lifecycle {
    create_before_destroy = true
  }
  display_name = "string"
  inclusive    = false
  percentage   = 0
  active       = false
  country      = "string"
  description  = "string"
  jurisdiction = "string"
  metadata = {
    "string" = "string"
  }
  state    = "string"
  tax_type = "string"
}

var taxRateResource = new TaxRate("taxRateResource", TaxRateArgs.builder()
    .displayName("string")
    .inclusive(false)
    .percentage(0.0)
    .active(false)
    .country("string")
    .description("string")
    .jurisdiction("string")
    .metadata(Map.of("string", "string"))
    .state("string")
    .taxType("string")
    .build());

tax_rate_resource = stripe.TaxRate("taxRateResource",
    display_name="string",
    inclusive=False,
    percentage=float(0),
    active=False,
    country="string",
    description="string",
    jurisdiction="string",
    metadata={
        "string": "string",
    },
    state="string",
    tax_type="string")

const taxRateResource = new stripe.TaxRate("taxRateResource", {
    displayName: "string",
    inclusive: false,
    percentage: 0,
    active: false,
    country: "string",
    description: "string",
    jurisdiction: "string",
    metadata: {
        string: "string",
    },
    state: "string",
    taxType: "string",
});

type: stripe:TaxRate
properties:
    active: false
    country: string
    description: string
    displayName: string
    inclusive: false
    jurisdiction: string
    metadata:
        string: string
    percentage: 0
    state: string
    taxType: string

TaxRate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TaxRate resource accepts the following input properties:

DisplayName string: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
Inclusive bool: This specifies if the tax rate is inclusive or exclusive.
Percentage double: 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.
Active bool: 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: Two-letter country code (ISO 3166-1 alpha-2).
Description string: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
Jurisdiction 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.
Metadata Dictionary<string, string>: 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.
State string: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
TaxType string: The high-level tax type, such as vat or sales_tax.

DisplayName string: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
Inclusive bool: This specifies if the tax rate is inclusive or exclusive.
Percentage float64: 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.
Active bool: 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: Two-letter country code (ISO 3166-1 alpha-2).
Description string: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
Jurisdiction 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.
Metadata map[string]string: 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.
State string: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
TaxType string: The high-level tax type, such as vat or sales_tax.

display_name string: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
inclusive bool: This specifies if the tax rate is inclusive or exclusive.
percentage number: 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.
active bool: 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: Two-letter country code (ISO 3166-1 alpha-2).
description string: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
jurisdiction 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.
metadata map(string): 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.
state string: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type string: The high-level tax type, such as vat or sales_tax.

displayName String: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
inclusive Boolean: This specifies if the tax rate is inclusive or exclusive.
percentage Double: 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.
active 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 String: Two-letter country code (ISO 3166-1 alpha-2).
description String: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
jurisdiction 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.
metadata Map<String,String>: 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.
state String: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
taxType String: The high-level tax type, such as vat or sales_tax.

displayName string: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
inclusive boolean: This specifies if the tax rate is inclusive or exclusive.
percentage number: 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.
active 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 string: Two-letter country code (ISO 3166-1 alpha-2).
description string: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
jurisdiction 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.
metadata {[key: string]: string}: 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.
state string: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
taxType string: The high-level tax type, such as vat or sales_tax.

display_name str: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
inclusive bool: This specifies if the tax rate is inclusive or exclusive.
percentage float: 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.
active bool: 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 str: Two-letter country code (ISO 3166-1 alpha-2).
description str: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
jurisdiction str: The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
metadata Mapping[str, str]: 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.
state str: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type str: The high-level tax type, such as vat or sales_tax.

displayName String: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
inclusive Boolean: This specifies if the tax rate is inclusive or exclusive.
percentage Number: 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.
active 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 String: Two-letter country code (ISO 3166-1 alpha-2).
description String: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
jurisdiction 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.
metadata Map<String>: 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.
state String: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
taxType String: The high-level tax type, such as vat or sales_tax.

Outputs

All input properties are implicitly available as output properties. Additionally, the TaxRate resource produces the following output properties:

Created double: Time at which the object was created. Measured in seconds since the Unix epoch.
EffectivePercentage double: 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.
FlatAmount TaxRateFlatAmount: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
Id string: The provider-assigned unique ID for this managed resource.
JurisdictionLevel string: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Object string: String representing the object's type. Objects of the same type share the same value.
RateType string: 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.

Created float64: Time at which the object was created. Measured in seconds since the Unix epoch.
EffectivePercentage float64: 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.
FlatAmount TaxRateFlatAmount: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
Id string: The provider-assigned unique ID for this managed resource.
JurisdictionLevel string: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Object string: String representing the object's type. Objects of the same type share the same value.
RateType string: 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.

created number: Time at which the object was created. Measured in seconds since the Unix epoch.
effective_percentage number: 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_amount object: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
id string: The provider-assigned unique ID for this managed resource.
jurisdiction_level string: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object string: String representing the object's type. Objects of the same type share the same value.
rate_type string: 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.

created Double: Time at which the object was created. Measured in seconds since the Unix epoch.
effectivePercentage Double: 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.
flatAmount TaxRateFlatAmount: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
id String: The provider-assigned unique ID for this managed resource.
jurisdictionLevel String: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object String: String representing the object's type. Objects of the same type share the same value.
rateType String: 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.

created number: Time at which the object was created. Measured in seconds since the Unix epoch.
effectivePercentage number: 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.
flatAmount TaxRateFlatAmount: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
id string: The provider-assigned unique ID for this managed resource.
jurisdictionLevel string: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object string: String representing the object's type. Objects of the same type share the same value.
rateType string: 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.

created float: Time at which the object was created. Measured in seconds since the Unix epoch.
effective_percentage 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_amount TaxRateFlatAmount: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
id str: The provider-assigned unique ID for this managed resource.
jurisdiction_level str: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object str: String representing the object's type. Objects of the same type share the same value.
rate_type str: 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.

created Number: Time at which the object was created. Measured in seconds since the Unix epoch.
effectivePercentage Number: 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.
flatAmount Property Map: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
id String: The provider-assigned unique ID for this managed resource.
jurisdictionLevel String: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object String: String representing the object's type. Objects of the same type share the same value.
rateType String: 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.

Look up Existing TaxRate Resource

Get an existing TaxRate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TaxRateState, opts?: CustomResourceOptions): TaxRate

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        country: Optional[str] = None,
        created: Optional[float] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_percentage: Optional[float] = None,
        flat_amount: Optional[TaxRateFlatAmountArgs] = None,
        inclusive: Optional[bool] = None,
        jurisdiction: Optional[str] = None,
        jurisdiction_level: Optional[str] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        object: Optional[str] = None,
        percentage: Optional[float] = None,
        rate_type: Optional[str] = None,
        state: Optional[str] = None,
        tax_type: Optional[str] = None) -> TaxRate

func GetTaxRate(ctx *Context, name string, id IDInput, state *TaxRateState, opts ...ResourceOption) (*TaxRate, error)

public static TaxRate Get(string name, Input<string> id, TaxRateState? state, CustomResourceOptions? opts = null)

public static TaxRate get(String name, Output<String> id, TaxRateState state, CustomResourceOptions options)

resources:  _:    type: stripe:TaxRate    get:      id: ${id}

import {
  to = stripe_tax_rate.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Active bool: 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: Two-letter country code (ISO 3166-1 alpha-2).
Created double: Time at which the object was created. Measured in seconds since the Unix epoch.
Description string: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
DisplayName string: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
EffectivePercentage double: 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.
FlatAmount TaxRateFlatAmount: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
Inclusive bool: This specifies if the tax rate is inclusive or exclusive.
Jurisdiction 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.
JurisdictionLevel string: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Metadata Dictionary<string, string>: 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 string: String representing the object's type. Objects of the same type share the same value.
Percentage double: 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.
RateType string: 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.
State string: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
TaxType string: The high-level tax type, such as vat or sales_tax.

Active bool: 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: Two-letter country code (ISO 3166-1 alpha-2).
Created float64: Time at which the object was created. Measured in seconds since the Unix epoch.
Description string: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
DisplayName string: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
EffectivePercentage float64: 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.
FlatAmount TaxRateFlatAmountArgs: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
Inclusive bool: This specifies if the tax rate is inclusive or exclusive.
Jurisdiction 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.
JurisdictionLevel string: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Metadata map[string]string: 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 string: String representing the object's type. Objects of the same type share the same value.
Percentage float64: 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.
RateType string: 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.
State string: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
TaxType string: The high-level tax type, such as vat or sales_tax.

active bool: 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: Two-letter country code (ISO 3166-1 alpha-2).
created number: Time at which the object was created. Measured in seconds since the Unix epoch.
description string: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name string: 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_percentage number: 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_amount object: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
inclusive bool: This specifies if the tax rate is inclusive or exclusive.
jurisdiction 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.
jurisdiction_level string: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata map(string): 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 string: String representing the object's type. Objects of the same type share the same value.
percentage number: 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 string: 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.
state string: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type string: The high-level tax type, such as vat or sales_tax.

active 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 String: Two-letter country code (ISO 3166-1 alpha-2).
created Double: Time at which the object was created. Measured in seconds since the Unix epoch.
description String: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
displayName String: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effectivePercentage Double: 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.
flatAmount TaxRateFlatAmount: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
inclusive Boolean: This specifies if the tax rate is inclusive or exclusive.
jurisdiction 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.
jurisdictionLevel String: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata Map<String,String>: 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 String: String representing the object's type. Objects of the same type share the same value.
percentage Double: 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.
rateType String: 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.
state String: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
taxType String: The high-level tax type, such as vat or sales_tax.

active 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 string: Two-letter country code (ISO 3166-1 alpha-2).
created number: Time at which the object was created. Measured in seconds since the Unix epoch.
description string: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
displayName string: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effectivePercentage number: 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.
flatAmount TaxRateFlatAmount: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
inclusive boolean: This specifies if the tax rate is inclusive or exclusive.
jurisdiction 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.
jurisdictionLevel string: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata {[key: string]: string}: 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 string: String representing the object's type. Objects of the same type share the same value.
percentage number: 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.
rateType string: 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.
state string: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
taxType string: The high-level tax type, such as vat or sales_tax.

active bool: 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 str: Two-letter country code (ISO 3166-1 alpha-2).
created float: Time at which the object was created. Measured in seconds since the Unix epoch.
description str: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
display_name str: 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_percentage 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_amount TaxRateFlatAmountArgs: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
inclusive bool: This specifies if the tax rate is inclusive or exclusive.
jurisdiction str: 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 str: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata Mapping[str, str]: 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 str: String representing the object's type. Objects of the same type share the same value.
percentage float: 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 str: 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.
state str: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
tax_type str: The high-level tax type, such as vat or sales_tax.

active 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 String: Two-letter country code (ISO 3166-1 alpha-2).
created Number: Time at which the object was created. Measured in seconds since the Unix epoch.
description String: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
displayName String: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
effectivePercentage Number: 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.
flatAmount Property Map: The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.
inclusive Boolean: This specifies if the tax rate is inclusive or exclusive.
jurisdiction 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.
jurisdictionLevel String: The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata Map<String>: 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 String: String representing the object's type. Objects of the same type share the same value.
percentage Number: 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.
rateType String: 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.
state String: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
taxType String: The high-level tax type, such as vat or sales_tax.

Supporting Types

TaxRateFlatAmount, TaxRateFlatAmountArgs

Amount double: Amount of the tax when the rate_type is flat_amount. 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).
Currency string: Three-letter ISO currency code, in lowercase.

Amount float64: Amount of the tax when the rate_type is flat_amount. 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).
Currency string: Three-letter ISO currency code, in lowercase.

amount number: Amount of the tax when the rate_type is flat_amount. 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).
currency string: Three-letter ISO currency code, in lowercase.

amount Double: Amount of the tax when the rate_type is flat_amount. 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).
currency String: Three-letter ISO currency code, in lowercase.

amount number: Amount of the tax when the rate_type is flat_amount. 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).
currency string: Three-letter ISO currency code, in lowercase.

amount float: Amount of the tax when the rate_type is flat_amount. 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).
currency str: Three-letter ISO currency code, in lowercase.

amount Number: Amount of the tax when the rate_type is flat_amount. 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).
currency String: Three-letter ISO currency code, in lowercase.

Package Details

Repository: stripe stripe/terraform-provider-stripe
License
Notes: This Pulumi package is based on the stripe Terraform Provider.

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

Schema (JSON)

stripe/terraform-provider-stripe

stripe.TaxRate

On this page

On this page

Create TaxRate Resource

Constructor syntax

Parameters

Constructor example

TaxRate Resource Properties

Inputs

Outputs

Look up Existing TaxRate Resource

Supporting Types

TaxRateFlatAmount, TaxRateFlatAmountArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

stripe.TaxRate

On this page

On this page

Create TaxRate Resource

Constructor syntax

Parameters

Constructor example

TaxRate Resource Properties

Inputs

Outputs

Look up Existing TaxRate Resource

Supporting Types

TaxRateFlatAmount, TaxRateFlatAmountArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.