Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. ShippingRate
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.ShippingRate

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.

    Create ShippingRate Resource

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

    Constructor syntax

    new ShippingRate(name: string, args: ShippingRateArgs, opts?: CustomResourceOptions);
    @overload
def ShippingRate(resource_name: str,
                 args: ShippingRateArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ShippingRate(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 display_name: Optional[str] = None,
                 active: Optional[bool] = None,
                 delivery_estimates: Optional[Sequence[ShippingRateDeliveryEstimateArgs]] = None,
                 fixed_amounts: Optional[Sequence[ShippingRateFixedAmountArgs]] = None,
                 metadata: Optional[Mapping[str, str]] = None,
                 tax_behavior: Optional[str] = None,
                 tax_code: Optional[str] = None,
                 type: Optional[str] = None)
    func NewShippingRate(ctx *Context, name string, args ShippingRateArgs, opts ...ResourceOption) (*ShippingRate, error)
    public ShippingRate(string name, ShippingRateArgs args, CustomResourceOptions? opts = null)
    public ShippingRate(String name, ShippingRateArgs args)
public ShippingRate(String name, ShippingRateArgs args, CustomResourceOptions options)

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


    resource "stripe_shipping_rate" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ShippingRateArgs
    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 ShippingRateArgs
    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 ShippingRateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShippingRateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShippingRateArgs
    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 shippingRateResource = new Stripe.ShippingRate("shippingRateResource", new()
{
    DisplayName = "string",
    Active = false,
    DeliveryEstimates = new[]
    {
        new Stripe.Inputs.ShippingRateDeliveryEstimateArgs
        {
            Maximums = new[]
            {
                new Stripe.Inputs.ShippingRateDeliveryEstimateMaximumArgs
                {
                    Unit = "string",
                    Value = 0.0,
                },
            },
            Minimums = new[]
            {
                new Stripe.Inputs.ShippingRateDeliveryEstimateMinimumArgs
                {
                    Unit = "string",
                    Value = 0.0,
                },
            },
        },
    },
    FixedAmounts = new[]
    {
        new Stripe.Inputs.ShippingRateFixedAmountArgs
        {
            Amount = 0.0,
            Currency = "string",
            CurrencyOptions = new[]
            {
                new Stripe.Inputs.ShippingRateFixedAmountCurrencyOptionArgs
                {
                    Amount = 0.0,
                    Key = "string",
                    TaxBehavior = "string",
                },
            },
        },
    },
    Metadata = 
    {
        { "string", "string" },
    },
    TaxBehavior = "string",
    TaxCode = "string",
    Type = "string",
});

    example, err := stripe.NewShippingRate(ctx, "shippingRateResource", &stripe.ShippingRateArgs{
	DisplayName: pulumi.String("string"),
	Active:      pulumi.Bool(false),
	DeliveryEstimates: stripe.ShippingRateDeliveryEstimateArray{
		&stripe.ShippingRateDeliveryEstimateArgs{
			Maximums: stripe.ShippingRateDeliveryEstimateMaximumArray{
				&stripe.ShippingRateDeliveryEstimateMaximumArgs{
					Unit:  pulumi.String("string"),
					Value: pulumi.Float64(0),
				},
			},
			Minimums: stripe.ShippingRateDeliveryEstimateMinimumArray{
				&stripe.ShippingRateDeliveryEstimateMinimumArgs{
					Unit:  pulumi.String("string"),
					Value: pulumi.Float64(0),
				},
			},
		},
	},
	FixedAmounts: stripe.ShippingRateFixedAmountArray{
		&stripe.ShippingRateFixedAmountArgs{
			Amount:   pulumi.Float64(0),
			Currency: pulumi.String("string"),
			CurrencyOptions: stripe.ShippingRateFixedAmountCurrencyOptionArray{
				&stripe.ShippingRateFixedAmountCurrencyOptionArgs{
					Amount:      pulumi.Float64(0),
					Key:         pulumi.String("string"),
					TaxBehavior: pulumi.String("string"),
				},
			},
		},
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TaxBehavior: pulumi.String("string"),
	TaxCode:     pulumi.String("string"),
	Type:        pulumi.String("string"),
})

    resource "stripe_shipping_rate" "shippingRateResource" {
  lifecycle {
    create_before_destroy = true
  }
  display_name = "string"
  active       = false
  delivery_estimates {
    maximums {
      unit  = "string"
      value = 0
    }
    minimums {
      unit  = "string"
      value = 0
    }
  }
  fixed_amounts {
    amount   = 0
    currency = "string"
    currency_options {
      amount       = 0
      key          = "string"
      tax_behavior = "string"
    }
  }
  metadata = {
    "string" = "string"
  }
  tax_behavior = "string"
  tax_code     = "string"
  type         = "string"
}

    var shippingRateResource = new ShippingRate("shippingRateResource", ShippingRateArgs.builder()
    .displayName("string")
    .active(false)
    .deliveryEstimates(ShippingRateDeliveryEstimateArgs.builder()
        .maximums(ShippingRateDeliveryEstimateMaximumArgs.builder()
            .unit("string")
            .value(0.0)
            .build())
        .minimums(ShippingRateDeliveryEstimateMinimumArgs.builder()
            .unit("string")
            .value(0.0)
            .build())
        .build())
    .fixedAmounts(ShippingRateFixedAmountArgs.builder()
        .amount(0.0)
        .currency("string")
        .currencyOptions(ShippingRateFixedAmountCurrencyOptionArgs.builder()
            .amount(0.0)
            .key("string")
            .taxBehavior("string")
            .build())
        .build())
    .metadata(Map.of("string", "string"))
    .taxBehavior("string")
    .taxCode("string")
    .type("string")
    .build());

    shipping_rate_resource = stripe.ShippingRate("shippingRateResource",
    display_name="string",
    active=False,
    delivery_estimates=[{
        "maximums": [{
            "unit": "string",
            "value": float(0),
        }],
        "minimums": [{
            "unit": "string",
            "value": float(0),
        }],
    }],
    fixed_amounts=[{
        "amount": float(0),
        "currency": "string",
        "currency_options": [{
            "amount": float(0),
            "key": "string",
            "tax_behavior": "string",
        }],
    }],
    metadata={
        "string": "string",
    },
    tax_behavior="string",
    tax_code="string",
    type="string")

    const shippingRateResource = new stripe.ShippingRate("shippingRateResource", {
    displayName: "string",
    active: false,
    deliveryEstimates: [{
        maximums: [{
            unit: "string",
            value: 0,
        }],
        minimums: [{
            unit: "string",
            value: 0,
        }],
    }],
    fixedAmounts: [{
        amount: 0,
        currency: "string",
        currencyOptions: [{
            amount: 0,
            key: "string",
            taxBehavior: "string",
        }],
    }],
    metadata: {
        string: "string",
    },
    taxBehavior: "string",
    taxCode: "string",
    type: "string",
});

    type: stripe:ShippingRate
properties:
    active: false
    deliveryEstimates:
        - maximums:
            - unit: string
              value: 0
          minimums:
            - unit: string
              value: 0
    displayName: string
    fixedAmounts:
        - amount: 0
          currency: string
          currencyOptions:
            - amount: 0
              key: string
              taxBehavior: string
    metadata:
        string: string
    taxBehavior: string
    taxCode: string
    type: string

    ShippingRate 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 ShippingRate resource accepts the following input properties:

    DisplayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    Active bool
    Whether the shipping rate can be used for new purchases. Defaults to true.
    DeliveryEstimates List<ShippingRateDeliveryEstimate>
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    FixedAmounts List<ShippingRateFixedAmount>
    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.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    TaxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    Type string
    The type of calculation to use on the shipping rate.
    DisplayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    Active bool
    Whether the shipping rate can be used for new purchases. Defaults to true.
    DeliveryEstimates []ShippingRateDeliveryEstimateArgs
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    FixedAmounts []ShippingRateFixedAmountArgs
    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.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    TaxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    Type string
    The type of calculation to use on the shipping rate.
    display_name string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    active bool
    Whether the shipping rate can be used for new purchases. Defaults to true.
    delivery_estimates list(object)
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixed_amounts list(object)
    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.
    tax_behavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    tax_code string
    A tax code ID. The Shipping tax code is txcd_92010001.
    type string
    The type of calculation to use on the shipping rate.
    displayName String
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    active Boolean
    Whether the shipping rate can be used for new purchases. Defaults to true.
    deliveryEstimates List<ShippingRateDeliveryEstimate>
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmounts List<ShippingRateFixedAmount>
    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.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode String
    A tax code ID. The Shipping tax code is txcd_92010001.
    type String
    The type of calculation to use on the shipping rate.
    displayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    active boolean
    Whether the shipping rate can be used for new purchases. Defaults to true.
    deliveryEstimates ShippingRateDeliveryEstimate[]
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmounts ShippingRateFixedAmount[]
    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.
    taxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    type string
    The type of calculation to use on the shipping rate.
    display_name str
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    active bool
    Whether the shipping rate can be used for new purchases. Defaults to true.
    delivery_estimates Sequence[ShippingRateDeliveryEstimateArgs]
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixed_amounts Sequence[ShippingRateFixedAmountArgs]
    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.
    tax_behavior str
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    tax_code str
    A tax code ID. The Shipping tax code is txcd_92010001.
    type str
    The type of calculation to use on the shipping rate.
    displayName String
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    active Boolean
    Whether the shipping rate can be used for new purchases. Defaults to true.
    deliveryEstimates List<Property Map>
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmounts List<Property Map>
    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.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode String
    A tax code ID. The Shipping tax code is txcd_92010001.
    type String
    The type of calculation to use on the shipping rate.

    Outputs

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

    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Look up Existing ShippingRate Resource

    Get an existing ShippingRate 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?: ShippingRateState, opts?: CustomResourceOptions): ShippingRate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        created: Optional[float] = None,
        delivery_estimates: Optional[Sequence[ShippingRateDeliveryEstimateArgs]] = None,
        display_name: Optional[str] = None,
        fixed_amounts: Optional[Sequence[ShippingRateFixedAmountArgs]] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        object: Optional[str] = None,
        tax_behavior: Optional[str] = None,
        tax_code: Optional[str] = None,
        type: Optional[str] = None) -> ShippingRate
    func GetShippingRate(ctx *Context, name string, id IDInput, state *ShippingRateState, opts ...ResourceOption) (*ShippingRate, error)
    public static ShippingRate Get(string name, Input<string> id, ShippingRateState? state, CustomResourceOptions? opts = null)
    public static ShippingRate get(String name, Output<String> id, ShippingRateState state, CustomResourceOptions options)
    resources:  _:    type: stripe:ShippingRate    get:      id: ${id}
    import {
  to = stripe_shipping_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
    Whether the shipping rate can be used for new purchases. Defaults to true.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    DeliveryEstimates List<ShippingRateDeliveryEstimate>
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    DisplayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    FixedAmounts List<ShippingRateFixedAmount>
    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.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    TaxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    Type string
    The type of calculation to use on the shipping rate.
    Active bool
    Whether the shipping rate can be used for new purchases. Defaults to true.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    DeliveryEstimates []ShippingRateDeliveryEstimateArgs
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    DisplayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    FixedAmounts []ShippingRateFixedAmountArgs
    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.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    TaxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    Type string
    The type of calculation to use on the shipping rate.
    active bool
    Whether the shipping rate can be used for new purchases. Defaults to true.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    delivery_estimates list(object)
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    display_name string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixed_amounts list(object)
    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.
    tax_behavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    tax_code string
    A tax code ID. The Shipping tax code is txcd_92010001.
    type string
    The type of calculation to use on the shipping rate.
    active Boolean
    Whether the shipping rate can be used for new purchases. Defaults to true.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    deliveryEstimates List<ShippingRateDeliveryEstimate>
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    displayName String
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmounts List<ShippingRateFixedAmount>
    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.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode String
    A tax code ID. The Shipping tax code is txcd_92010001.
    type String
    The type of calculation to use on the shipping rate.
    active boolean
    Whether the shipping rate can be used for new purchases. Defaults to true.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    deliveryEstimates ShippingRateDeliveryEstimate[]
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    displayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmounts ShippingRateFixedAmount[]
    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.
    taxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    type string
    The type of calculation to use on the shipping rate.
    active bool
    Whether the shipping rate can be used for new purchases. Defaults to true.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    delivery_estimates Sequence[ShippingRateDeliveryEstimateArgs]
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    display_name str
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixed_amounts Sequence[ShippingRateFixedAmountArgs]
    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.
    tax_behavior str
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    tax_code str
    A tax code ID. The Shipping tax code is txcd_92010001.
    type str
    The type of calculation to use on the shipping rate.
    active Boolean
    Whether the shipping rate can be used for new purchases. Defaults to true.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    deliveryEstimates List<Property Map>
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    displayName String
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmounts List<Property Map>
    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.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode String
    A tax code ID. The Shipping tax code is txcd_92010001.
    type String
    The type of calculation to use on the shipping rate.

    Supporting Types

    ShippingRateDeliveryEstimate, ShippingRateDeliveryEstimateArgs

    Maximums List<ShippingRateDeliveryEstimateMaximum>
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    Minimums List<ShippingRateDeliveryEstimateMinimum>
    The lower bound of the estimated range. If empty, represents no lower bound.
    Maximums []ShippingRateDeliveryEstimateMaximum
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    Minimums []ShippingRateDeliveryEstimateMinimum
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximums list(object)
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimums list(object)
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximums List<ShippingRateDeliveryEstimateMaximum>
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimums List<ShippingRateDeliveryEstimateMinimum>
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximums ShippingRateDeliveryEstimateMaximum[]
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimums ShippingRateDeliveryEstimateMinimum[]
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximums Sequence[ShippingRateDeliveryEstimateMaximum]
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimums Sequence[ShippingRateDeliveryEstimateMinimum]
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximums List<Property Map>
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimums List<Property Map>
    The lower bound of the estimated range. If empty, represents no lower bound.

    ShippingRateDeliveryEstimateMaximum, ShippingRateDeliveryEstimateMaximumArgs

    Unit string
    A unit of time.
    Value double
    Must be greater than 0.
    Unit string
    A unit of time.
    Value float64
    Must be greater than 0.
    unit string
    A unit of time.
    value number
    Must be greater than 0.
    unit String
    A unit of time.
    value Double
    Must be greater than 0.
    unit string
    A unit of time.
    value number
    Must be greater than 0.
    unit str
    A unit of time.
    value float
    Must be greater than 0.
    unit String
    A unit of time.
    value Number
    Must be greater than 0.

    ShippingRateDeliveryEstimateMinimum, ShippingRateDeliveryEstimateMinimumArgs

    Unit string
    A unit of time.
    Value double
    Must be greater than 0.
    Unit string
    A unit of time.
    Value float64
    Must be greater than 0.
    unit string
    A unit of time.
    value number
    Must be greater than 0.
    unit String
    A unit of time.
    value Double
    Must be greater than 0.
    unit string
    A unit of time.
    value number
    Must be greater than 0.
    unit str
    A unit of time.
    value float
    Must be greater than 0.
    unit String
    A unit of time.
    value Number
    Must be greater than 0.

    ShippingRateFixedAmount, ShippingRateFixedAmountArgs

    Amount double
    A non-negative integer in cents representing how much to charge.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CurrencyOptions List<ShippingRateFixedAmountCurrencyOption>
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    Amount float64
    A non-negative integer in cents representing how much to charge.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CurrencyOptions []ShippingRateFixedAmountCurrencyOption
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount number
    A non-negative integer in cents representing how much to charge.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currency_options list(object)
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount Double
    A non-negative integer in cents representing how much to charge.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions List<ShippingRateFixedAmountCurrencyOption>
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount number
    A non-negative integer in cents representing how much to charge.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions ShippingRateFixedAmountCurrencyOption[]
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount float
    A non-negative integer in cents representing how much to charge.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currency_options Sequence[ShippingRateFixedAmountCurrencyOption]
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount Number
    A non-negative integer in cents representing how much to charge.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions List<Property Map>
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

    ShippingRateFixedAmountCurrencyOption, ShippingRateFixedAmountCurrencyOptionArgs

    Amount double
    A non-negative integer in cents representing how much to charge.
    Key string
    Key for this entry.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    Amount float64
    A non-negative integer in cents representing how much to charge.
    Key string
    Key for this entry.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount number
    A non-negative integer in cents representing how much to charge.
    key string
    Key for this entry.
    tax_behavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount Double
    A non-negative integer in cents representing how much to charge.
    key String
    Key for this entry.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount number
    A non-negative integer in cents representing how much to charge.
    key string
    Key for this entry.
    taxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount float
    A non-negative integer in cents representing how much to charge.
    key str
    Key for this entry.
    tax_behavior str
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount Number
    A non-negative integer in cents representing how much to charge.
    key String
    Key for this entry.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial