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

stripe.Product

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

    Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, Checkout, and Subscriptions.

    Related guides: Set up a subscription, share a Payment Link, accept payments with Checkout, and more about Products and Prices

    Create Product Resource

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

    Constructor syntax

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

@overload
def Product(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            active: Optional[bool] = None,
            default_price_datas: Optional[Sequence[ProductDefaultPriceDataArgs]] = None,
            description: Optional[str] = None,
            images: Optional[Sequence[str]] = None,
            marketing_features: Optional[Sequence[ProductMarketingFeatureArgs]] = None,
            metadata: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            package_dimensions: Optional[Sequence[ProductPackageDimensionArgs]] = None,
            shippable: Optional[bool] = None,
            statement_descriptor: Optional[str] = None,
            tax_code: Optional[str] = None,
            type: Optional[str] = None,
            unit_label: Optional[str] = None,
            url: Optional[str] = None)
    func NewProduct(ctx *Context, name string, args *ProductArgs, opts ...ResourceOption) (*Product, error)
    public Product(string name, ProductArgs? args = null, CustomResourceOptions? opts = null)
    public Product(String name, ProductArgs args)
public Product(String name, ProductArgs args, CustomResourceOptions options)

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


    resource "stripe_product" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ProductArgs
    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 ProductArgs
    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 ProductArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProductArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProductArgs
    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 productResource = new Stripe.Product("productResource", new()
{
    Active = false,
    DefaultPriceDatas = new[]
    {
        new Stripe.Inputs.ProductDefaultPriceDataArgs
        {
            Currency = "string",
            CurrencyOptions = new[]
            {
                new Stripe.Inputs.ProductDefaultPriceDataCurrencyOptionArgs
                {
                    Key = "string",
                    CustomUnitAmounts = new[]
                    {
                        new Stripe.Inputs.ProductDefaultPriceDataCurrencyOptionCustomUnitAmountArgs
                        {
                            Enabled = false,
                            Maximum = 0.0,
                            Minimum = 0.0,
                            Preset = 0.0,
                        },
                    },
                    TaxBehavior = "string",
                    Tiers = new[]
                    {
                        new Stripe.Inputs.ProductDefaultPriceDataCurrencyOptionTierArgs
                        {
                            UpTo = 0.0,
                            FlatAmount = 0.0,
                            FlatAmountDecimal = "string",
                            UnitAmount = 0.0,
                            UnitAmountDecimal = "string",
                        },
                    },
                    UnitAmount = 0.0,
                    UnitAmountDecimal = "string",
                },
            },
            CustomUnitAmounts = new[]
            {
                new Stripe.Inputs.ProductDefaultPriceDataCustomUnitAmountArgs
                {
                    Enabled = false,
                    Maximum = 0.0,
                    Minimum = 0.0,
                    Preset = 0.0,
                },
            },
            Metadata = 
            {
                { "string", "string" },
            },
            Recurrings = new[]
            {
                new Stripe.Inputs.ProductDefaultPriceDataRecurringArgs
                {
                    Interval = "string",
                    IntervalCount = 0.0,
                },
            },
            TaxBehavior = "string",
            UnitAmount = 0.0,
            UnitAmountDecimal = "string",
        },
    },
    Description = "string",
    Images = new[]
    {
        "string",
    },
    MarketingFeatures = new[]
    {
        new Stripe.Inputs.ProductMarketingFeatureArgs
        {
            Name = "string",
        },
    },
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    PackageDimensions = new[]
    {
        new Stripe.Inputs.ProductPackageDimensionArgs
        {
            Height = 0.0,
            Length = 0.0,
            Weight = 0.0,
            Width = 0.0,
        },
    },
    Shippable = false,
    StatementDescriptor = "string",
    TaxCode = "string",
    Type = "string",
    UnitLabel = "string",
    Url = "string",
});

    example, err := stripe.NewProduct(ctx, "productResource", &stripe.ProductArgs{
	Active: pulumi.Bool(false),
	DefaultPriceDatas: stripe.ProductDefaultPriceDataArray{
		&stripe.ProductDefaultPriceDataArgs{
			Currency: pulumi.String("string"),
			CurrencyOptions: stripe.ProductDefaultPriceDataCurrencyOptionArray{
				&stripe.ProductDefaultPriceDataCurrencyOptionArgs{
					Key: pulumi.String("string"),
					CustomUnitAmounts: stripe.ProductDefaultPriceDataCurrencyOptionCustomUnitAmountArray{
						&stripe.ProductDefaultPriceDataCurrencyOptionCustomUnitAmountArgs{
							Enabled: pulumi.Bool(false),
							Maximum: pulumi.Float64(0),
							Minimum: pulumi.Float64(0),
							Preset:  pulumi.Float64(0),
						},
					},
					TaxBehavior: pulumi.String("string"),
					Tiers: stripe.ProductDefaultPriceDataCurrencyOptionTierArray{
						&stripe.ProductDefaultPriceDataCurrencyOptionTierArgs{
							UpTo:              pulumi.Float64(0),
							FlatAmount:        pulumi.Float64(0),
							FlatAmountDecimal: pulumi.String("string"),
							UnitAmount:        pulumi.Float64(0),
							UnitAmountDecimal: pulumi.String("string"),
						},
					},
					UnitAmount:        pulumi.Float64(0),
					UnitAmountDecimal: pulumi.String("string"),
				},
			},
			CustomUnitAmounts: stripe.ProductDefaultPriceDataCustomUnitAmountArray{
				&stripe.ProductDefaultPriceDataCustomUnitAmountArgs{
					Enabled: pulumi.Bool(false),
					Maximum: pulumi.Float64(0),
					Minimum: pulumi.Float64(0),
					Preset:  pulumi.Float64(0),
				},
			},
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Recurrings: stripe.ProductDefaultPriceDataRecurringArray{
				&stripe.ProductDefaultPriceDataRecurringArgs{
					Interval:      pulumi.String("string"),
					IntervalCount: pulumi.Float64(0),
				},
			},
			TaxBehavior:       pulumi.String("string"),
			UnitAmount:        pulumi.Float64(0),
			UnitAmountDecimal: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Images: pulumi.StringArray{
		pulumi.String("string"),
	},
	MarketingFeatures: stripe.ProductMarketingFeatureArray{
		&stripe.ProductMarketingFeatureArgs{
			Name: pulumi.String("string"),
		},
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	PackageDimensions: stripe.ProductPackageDimensionArray{
		&stripe.ProductPackageDimensionArgs{
			Height: pulumi.Float64(0),
			Length: pulumi.Float64(0),
			Weight: pulumi.Float64(0),
			Width:  pulumi.Float64(0),
		},
	},
	Shippable:           pulumi.Bool(false),
	StatementDescriptor: pulumi.String("string"),
	TaxCode:             pulumi.String("string"),
	Type:                pulumi.String("string"),
	UnitLabel:           pulumi.String("string"),
	Url:                 pulumi.String("string"),
})

    resource "stripe_product" "productResource" {
  lifecycle {
    create_before_destroy = true
  }
  active = false
  default_price_datas {
    currency = "string"
    currency_options {
      key = "string"
      custom_unit_amounts {
        enabled = false
        maximum = 0
        minimum = 0
        preset  = 0
      }
      tax_behavior = "string"
      tiers {
        up_to               = 0
        flat_amount         = 0
        flat_amount_decimal = "string"
        unit_amount         = 0
        unit_amount_decimal = "string"
      }
      unit_amount         = 0
      unit_amount_decimal = "string"
    }
    custom_unit_amounts {
      enabled = false
      maximum = 0
      minimum = 0
      preset  = 0
    }
    metadata = {
      "string" = "string"
    }
    recurrings {
      interval       = "string"
      interval_count = 0
    }
    tax_behavior        = "string"
    unit_amount         = 0
    unit_amount_decimal = "string"
  }
  description = "string"
  images      = ["string"]
  marketing_features {
    name = "string"
  }
  metadata = {
    "string" = "string"
  }
  name = "string"
  package_dimensions {
    height = 0
    length = 0
    weight = 0
    width  = 0
  }
  shippable            = false
  statement_descriptor = "string"
  tax_code             = "string"
  type                 = "string"
  unit_label           = "string"
  url                  = "string"
}

    var productResource = new Product("productResource", ProductArgs.builder()
    .active(false)
    .defaultPriceDatas(ProductDefaultPriceDataArgs.builder()
        .currency("string")
        .currencyOptions(ProductDefaultPriceDataCurrencyOptionArgs.builder()
            .key("string")
            .customUnitAmounts(ProductDefaultPriceDataCurrencyOptionCustomUnitAmountArgs.builder()
                .enabled(false)
                .maximum(0.0)
                .minimum(0.0)
                .preset(0.0)
                .build())
            .taxBehavior("string")
            .tiers(ProductDefaultPriceDataCurrencyOptionTierArgs.builder()
                .upTo(0.0)
                .flatAmount(0.0)
                .flatAmountDecimal("string")
                .unitAmount(0.0)
                .unitAmountDecimal("string")
                .build())
            .unitAmount(0.0)
            .unitAmountDecimal("string")
            .build())
        .customUnitAmounts(ProductDefaultPriceDataCustomUnitAmountArgs.builder()
            .enabled(false)
            .maximum(0.0)
            .minimum(0.0)
            .preset(0.0)
            .build())
        .metadata(Map.of("string", "string"))
        .recurrings(ProductDefaultPriceDataRecurringArgs.builder()
            .interval("string")
            .intervalCount(0.0)
            .build())
        .taxBehavior("string")
        .unitAmount(0.0)
        .unitAmountDecimal("string")
        .build())
    .description("string")
    .images("string")
    .marketingFeatures(ProductMarketingFeatureArgs.builder()
        .name("string")
        .build())
    .metadata(Map.of("string", "string"))
    .name("string")
    .packageDimensions(ProductPackageDimensionArgs.builder()
        .height(0.0)
        .length(0.0)
        .weight(0.0)
        .width(0.0)
        .build())
    .shippable(false)
    .statementDescriptor("string")
    .taxCode("string")
    .type("string")
    .unitLabel("string")
    .url("string")
    .build());

    product_resource = stripe.Product("productResource",
    active=False,
    default_price_datas=[{
        "currency": "string",
        "currency_options": [{
            "key": "string",
            "custom_unit_amounts": [{
                "enabled": False,
                "maximum": float(0),
                "minimum": float(0),
                "preset": float(0),
            }],
            "tax_behavior": "string",
            "tiers": [{
                "up_to": float(0),
                "flat_amount": float(0),
                "flat_amount_decimal": "string",
                "unit_amount": float(0),
                "unit_amount_decimal": "string",
            }],
            "unit_amount": float(0),
            "unit_amount_decimal": "string",
        }],
        "custom_unit_amounts": [{
            "enabled": False,
            "maximum": float(0),
            "minimum": float(0),
            "preset": float(0),
        }],
        "metadata": {
            "string": "string",
        },
        "recurrings": [{
            "interval": "string",
            "interval_count": float(0),
        }],
        "tax_behavior": "string",
        "unit_amount": float(0),
        "unit_amount_decimal": "string",
    }],
    description="string",
    images=["string"],
    marketing_features=[{
        "name": "string",
    }],
    metadata={
        "string": "string",
    },
    name="string",
    package_dimensions=[{
        "height": float(0),
        "length": float(0),
        "weight": float(0),
        "width": float(0),
    }],
    shippable=False,
    statement_descriptor="string",
    tax_code="string",
    type="string",
    unit_label="string",
    url="string")

    const productResource = new stripe.Product("productResource", {
    active: false,
    defaultPriceDatas: [{
        currency: "string",
        currencyOptions: [{
            key: "string",
            customUnitAmounts: [{
                enabled: false,
                maximum: 0,
                minimum: 0,
                preset: 0,
            }],
            taxBehavior: "string",
            tiers: [{
                upTo: 0,
                flatAmount: 0,
                flatAmountDecimal: "string",
                unitAmount: 0,
                unitAmountDecimal: "string",
            }],
            unitAmount: 0,
            unitAmountDecimal: "string",
        }],
        customUnitAmounts: [{
            enabled: false,
            maximum: 0,
            minimum: 0,
            preset: 0,
        }],
        metadata: {
            string: "string",
        },
        recurrings: [{
            interval: "string",
            intervalCount: 0,
        }],
        taxBehavior: "string",
        unitAmount: 0,
        unitAmountDecimal: "string",
    }],
    description: "string",
    images: ["string"],
    marketingFeatures: [{
        name: "string",
    }],
    metadata: {
        string: "string",
    },
    name: "string",
    packageDimensions: [{
        height: 0,
        length: 0,
        weight: 0,
        width: 0,
    }],
    shippable: false,
    statementDescriptor: "string",
    taxCode: "string",
    type: "string",
    unitLabel: "string",
    url: "string",
});

    type: stripe:Product
properties:
    active: false
    defaultPriceDatas:
        - currency: string
          currencyOptions:
            - customUnitAmounts:
                - enabled: false
                  maximum: 0
                  minimum: 0
                  preset: 0
              key: string
              taxBehavior: string
              tiers:
                - flatAmount: 0
                  flatAmountDecimal: string
                  unitAmount: 0
                  unitAmountDecimal: string
                  upTo: 0
              unitAmount: 0
              unitAmountDecimal: string
          customUnitAmounts:
            - enabled: false
              maximum: 0
              minimum: 0
              preset: 0
          metadata:
            string: string
          recurrings:
            - interval: string
              intervalCount: 0
          taxBehavior: string
          unitAmount: 0
          unitAmountDecimal: string
    description: string
    images:
        - string
    marketingFeatures:
        - name: string
    metadata:
        string: string
    name: string
    packageDimensions:
        - height: 0
          length: 0
          weight: 0
          width: 0
    shippable: false
    statementDescriptor: string
    taxCode: string
    type: string
    unitLabel: string
    url: string

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

    Active bool
    Whether the product is currently available for purchase.
    DefaultPriceDatas List<ProductDefaultPriceData>
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    Description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    Images List<string>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    MarketingFeatures List<ProductMarketingFeature>
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    Name string
    The product's name, meant to be displayable to the customer.
    PackageDimensions List<ProductPackageDimension>
    The dimensions of this product for shipping purposes.
    Shippable bool
    Whether this product is shipped (i.e., physical goods).
    StatementDescriptor string
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    TaxCode string
    A tax code ID.
    Type string
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    UnitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    Url string
    A URL of a publicly-accessible webpage for this product.
    Active bool
    Whether the product is currently available for purchase.
    DefaultPriceDatas []ProductDefaultPriceDataArgs
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    Description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    Images []string
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    MarketingFeatures []ProductMarketingFeatureArgs
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    Name string
    The product's name, meant to be displayable to the customer.
    PackageDimensions []ProductPackageDimensionArgs
    The dimensions of this product for shipping purposes.
    Shippable bool
    Whether this product is shipped (i.e., physical goods).
    StatementDescriptor string
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    TaxCode string
    A tax code ID.
    Type string
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    UnitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    Url string
    A URL of a publicly-accessible webpage for this product.
    active bool
    Whether the product is currently available for purchase.
    default_price_datas list(object)
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images list(string)
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    marketing_features list(object)
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name string
    The product's name, meant to be displayable to the customer.
    package_dimensions list(object)
    The dimensions of this product for shipping purposes.
    shippable bool
    Whether this product is shipped (i.e., physical goods).
    statement_descriptor string
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    tax_code string
    A tax code ID.
    type string
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unit_label string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    url string
    A URL of a publicly-accessible webpage for this product.
    active Boolean
    Whether the product is currently available for purchase.
    defaultPriceDatas List<ProductDefaultPriceData>
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description String
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images List<String>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    marketingFeatures List<ProductMarketingFeature>
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name String
    The product's name, meant to be displayable to the customer.
    packageDimensions List<ProductPackageDimension>
    The dimensions of this product for shipping purposes.
    shippable Boolean
    Whether this product is shipped (i.e., physical goods).
    statementDescriptor String
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    taxCode String
    A tax code ID.
    type String
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unitLabel String
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    url String
    A URL of a publicly-accessible webpage for this product.
    active boolean
    Whether the product is currently available for purchase.
    defaultPriceDatas ProductDefaultPriceData[]
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images string[]
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    marketingFeatures ProductMarketingFeature[]
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name string
    The product's name, meant to be displayable to the customer.
    packageDimensions ProductPackageDimension[]
    The dimensions of this product for shipping purposes.
    shippable boolean
    Whether this product is shipped (i.e., physical goods).
    statementDescriptor string
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    taxCode string
    A tax code ID.
    type string
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    url string
    A URL of a publicly-accessible webpage for this product.
    active bool
    Whether the product is currently available for purchase.
    default_price_datas Sequence[ProductDefaultPriceDataArgs]
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description str
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images Sequence[str]
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    marketing_features Sequence[ProductMarketingFeatureArgs]
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name str
    The product's name, meant to be displayable to the customer.
    package_dimensions Sequence[ProductPackageDimensionArgs]
    The dimensions of this product for shipping purposes.
    shippable bool
    Whether this product is shipped (i.e., physical goods).
    statement_descriptor str
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    tax_code str
    A tax code ID.
    type str
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unit_label str
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    url str
    A URL of a publicly-accessible webpage for this product.
    active Boolean
    Whether the product is currently available for purchase.
    defaultPriceDatas List<Property Map>
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description String
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images List<String>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    marketingFeatures List<Property Map>
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name String
    The product's name, meant to be displayable to the customer.
    packageDimensions List<Property Map>
    The dimensions of this product for shipping purposes.
    shippable Boolean
    Whether this product is shipped (i.e., physical goods).
    statementDescriptor String
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    taxCode String
    A tax code ID.
    type String
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unitLabel String
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    url String
    A URL of a publicly-accessible webpage for this product.

    Outputs

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

    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    DefaultPrice string
    The ID of the Price object that is the default price for this product.
    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.
    Updated double
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    DefaultPrice string
    The ID of the Price object that is the default price for this product.
    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.
    Updated float64
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    default_price string
    The ID of the Price object that is the default price for this product.
    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.
    updated number
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultPrice String
    The ID of the Price object that is the default price for this product.
    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.
    updated Double
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultPrice string
    The ID of the Price object that is the default price for this product.
    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.
    updated number
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    default_price str
    The ID of the Price object that is the default price for this product.
    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.
    updated float
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultPrice String
    The ID of the Price object that is the default price for this product.
    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.
    updated Number
    Time at which the object was last updated. Measured in seconds since the Unix epoch.

    Look up Existing Product Resource

    Get an existing Product 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?: ProductState, opts?: CustomResourceOptions): Product
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        created: Optional[float] = None,
        default_price: Optional[str] = None,
        default_price_datas: Optional[Sequence[ProductDefaultPriceDataArgs]] = None,
        description: Optional[str] = None,
        images: Optional[Sequence[str]] = None,
        livemode: Optional[bool] = None,
        marketing_features: Optional[Sequence[ProductMarketingFeatureArgs]] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        object: Optional[str] = None,
        package_dimensions: Optional[Sequence[ProductPackageDimensionArgs]] = None,
        shippable: Optional[bool] = None,
        statement_descriptor: Optional[str] = None,
        tax_code: Optional[str] = None,
        type: Optional[str] = None,
        unit_label: Optional[str] = None,
        updated: Optional[float] = None,
        url: Optional[str] = None) -> Product
    func GetProduct(ctx *Context, name string, id IDInput, state *ProductState, opts ...ResourceOption) (*Product, error)
    public static Product Get(string name, Input<string> id, ProductState? state, CustomResourceOptions? opts = null)
    public static Product get(String name, Output<String> id, ProductState state, CustomResourceOptions options)
    resources:  _:    type: stripe:Product    get:      id: ${id}
    import {
  to = stripe_product.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 product is currently available for purchase.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    DefaultPrice string
    The ID of the Price object that is the default price for this product.
    DefaultPriceDatas List<ProductDefaultPriceData>
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    Description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    Images List<string>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    MarketingFeatures List<ProductMarketingFeature>
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    Name string
    The product's name, meant to be displayable to the customer.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PackageDimensions List<ProductPackageDimension>
    The dimensions of this product for shipping purposes.
    Shippable bool
    Whether this product is shipped (i.e., physical goods).
    StatementDescriptor string
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    TaxCode string
    A tax code ID.
    Type string
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    UnitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    Updated double
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    Url string
    A URL of a publicly-accessible webpage for this product.
    Active bool
    Whether the product is currently available for purchase.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    DefaultPrice string
    The ID of the Price object that is the default price for this product.
    DefaultPriceDatas []ProductDefaultPriceDataArgs
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    Description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    Images []string
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    MarketingFeatures []ProductMarketingFeatureArgs
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    Name string
    The product's name, meant to be displayable to the customer.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PackageDimensions []ProductPackageDimensionArgs
    The dimensions of this product for shipping purposes.
    Shippable bool
    Whether this product is shipped (i.e., physical goods).
    StatementDescriptor string
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    TaxCode string
    A tax code ID.
    Type string
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    UnitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    Updated float64
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    Url string
    A URL of a publicly-accessible webpage for this product.
    active bool
    Whether the product is currently available for purchase.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    default_price string
    The ID of the Price object that is the default price for this product.
    default_price_datas list(object)
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images list(string)
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    marketing_features list(object)
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name string
    The product's name, meant to be displayable to the customer.
    object string
    String representing the object's type. Objects of the same type share the same value.
    package_dimensions list(object)
    The dimensions of this product for shipping purposes.
    shippable bool
    Whether this product is shipped (i.e., physical goods).
    statement_descriptor string
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    tax_code string
    A tax code ID.
    type string
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unit_label string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    updated number
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    url string
    A URL of a publicly-accessible webpage for this product.
    active Boolean
    Whether the product is currently available for purchase.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultPrice String
    The ID of the Price object that is the default price for this product.
    defaultPriceDatas List<ProductDefaultPriceData>
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description String
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images List<String>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    marketingFeatures List<ProductMarketingFeature>
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name String
    The product's name, meant to be displayable to the customer.
    object String
    String representing the object's type. Objects of the same type share the same value.
    packageDimensions List<ProductPackageDimension>
    The dimensions of this product for shipping purposes.
    shippable Boolean
    Whether this product is shipped (i.e., physical goods).
    statementDescriptor String
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    taxCode String
    A tax code ID.
    type String
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unitLabel String
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    updated Double
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    url String
    A URL of a publicly-accessible webpage for this product.
    active boolean
    Whether the product is currently available for purchase.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultPrice string
    The ID of the Price object that is the default price for this product.
    defaultPriceDatas ProductDefaultPriceData[]
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description string
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images string[]
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    marketingFeatures ProductMarketingFeature[]
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name string
    The product's name, meant to be displayable to the customer.
    object string
    String representing the object's type. Objects of the same type share the same value.
    packageDimensions ProductPackageDimension[]
    The dimensions of this product for shipping purposes.
    shippable boolean
    Whether this product is shipped (i.e., physical goods).
    statementDescriptor string
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    taxCode string
    A tax code ID.
    type string
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unitLabel string
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    updated number
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    url string
    A URL of a publicly-accessible webpage for this product.
    active bool
    Whether the product is currently available for purchase.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    default_price str
    The ID of the Price object that is the default price for this product.
    default_price_datas Sequence[ProductDefaultPriceDataArgs]
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description str
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images Sequence[str]
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    marketing_features Sequence[ProductMarketingFeatureArgs]
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name str
    The product's name, meant to be displayable to the customer.
    object str
    String representing the object's type. Objects of the same type share the same value.
    package_dimensions Sequence[ProductPackageDimensionArgs]
    The dimensions of this product for shipping purposes.
    shippable bool
    Whether this product is shipped (i.e., physical goods).
    statement_descriptor str
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    tax_code str
    A tax code ID.
    type str
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unit_label str
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    updated float
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    url str
    A URL of a publicly-accessible webpage for this product.
    active Boolean
    Whether the product is currently available for purchase.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultPrice String
    The ID of the Price object that is the default price for this product.
    defaultPriceDatas List<Property Map>
    Data used to generate a new Price object. This Price will be set as the default price for this product.
    description String
    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
    images List<String>
    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    marketingFeatures List<Property Map>
    A list of up to 15 marketing features for this product. These are displayed in pricing tables.
    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.
    name String
    The product's name, meant to be displayable to the customer.
    object String
    String representing the object's type. Objects of the same type share the same value.
    packageDimensions List<Property Map>
    The dimensions of this product for shipping purposes.
    shippable Boolean
    Whether this product is shipped (i.e., physical goods).
    statementDescriptor String
    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
    taxCode String
    A tax code ID.
    type String
    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
    unitLabel String
    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
    updated Number
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    url String
    A URL of a publicly-accessible webpage for this product.

    Supporting Types

    ProductDefaultPriceData, ProductDefaultPriceDataArgs

    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CurrencyOptions List<ProductDefaultPriceDataCurrencyOption>
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    CustomUnitAmounts List<ProductDefaultPriceDataCustomUnitAmount>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    Recurrings List<ProductDefaultPriceDataRecurring>
    The recurring components of a price such as interval and interval_count.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.
    UnitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CurrencyOptions []ProductDefaultPriceDataCurrencyOption
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    CustomUnitAmounts []ProductDefaultPriceDataCustomUnitAmount
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    Recurrings []ProductDefaultPriceDataRecurring
    The recurring components of a price such as interval and interval_count.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount float64
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.
    UnitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currency_options list(object)
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    custom_unit_amounts list(object)
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    recurrings list(object)
    The recurring components of a price such as interval and interval_count.
    tax_behavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.
    unit_amount_decimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions List<ProductDefaultPriceDataCurrencyOption>
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    customUnitAmounts List<ProductDefaultPriceDataCustomUnitAmount>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    recurrings List<ProductDefaultPriceDataRecurring>
    The recurring components of a price such as interval and interval_count.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.
    unitAmountDecimal String
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions ProductDefaultPriceDataCurrencyOption[]
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    customUnitAmounts ProductDefaultPriceDataCustomUnitAmount[]
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    recurrings ProductDefaultPriceDataRecurring[]
    The recurring components of a price such as interval and interval_count.
    taxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.
    unitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currency_options Sequence[ProductDefaultPriceDataCurrencyOption]
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    custom_unit_amounts Sequence[ProductDefaultPriceDataCustomUnitAmount]
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    recurrings Sequence[ProductDefaultPriceDataRecurring]
    The recurring components of a price such as interval and interval_count.
    tax_behavior str
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount float
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.
    unit_amount_decimal str
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions List<Property Map>
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    customUnitAmounts List<Property Map>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    recurrings List<Property Map>
    The recurring components of a price such as interval and interval_count.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.
    unitAmountDecimal String
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    ProductDefaultPriceDataCurrencyOption, ProductDefaultPriceDataCurrencyOptionArgs

    Key string
    Key for this entry.
    CustomUnitAmounts List<ProductDefaultPriceDataCurrencyOptionCustomUnitAmount>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    Tiers List<ProductDefaultPriceDataCurrencyOptionTier>
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    UnitAmount double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    UnitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    Key string
    Key for this entry.
    CustomUnitAmounts []ProductDefaultPriceDataCurrencyOptionCustomUnitAmount
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    Tiers []ProductDefaultPriceDataCurrencyOptionTier
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    UnitAmount float64
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    UnitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    key string
    Key for this entry.
    custom_unit_amounts list(object)
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    tax_behavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    tiers list(object)
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    unit_amount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unit_amount_decimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    key String
    Key for this entry.
    customUnitAmounts List<ProductDefaultPriceDataCurrencyOptionCustomUnitAmount>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    tiers List<ProductDefaultPriceDataCurrencyOptionTier>
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    unitAmount Double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal String
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    key string
    Key for this entry.
    customUnitAmounts ProductDefaultPriceDataCurrencyOptionCustomUnitAmount[]
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    taxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    tiers ProductDefaultPriceDataCurrencyOptionTier[]
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    unitAmount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    key str
    Key for this entry.
    custom_unit_amounts Sequence[ProductDefaultPriceDataCurrencyOptionCustomUnitAmount]
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    tax_behavior str
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    tiers Sequence[ProductDefaultPriceDataCurrencyOptionTier]
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    unit_amount float
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unit_amount_decimal str
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    key String
    Key for this entry.
    customUnitAmounts List<Property Map>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    tiers List<Property Map>
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    unitAmount Number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal String
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    ProductDefaultPriceDataCurrencyOptionCustomUnitAmount, ProductDefaultPriceDataCurrencyOptionCustomUnitAmountArgs

    Enabled bool
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    Maximum double
    The maximum unit amount the customer can specify for this item.
    Minimum double
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    Preset double
    The starting unit amount which can be updated by the customer.
    Enabled bool
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    Maximum float64
    The maximum unit amount the customer can specify for this item.
    Minimum float64
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    Preset float64
    The starting unit amount which can be updated by the customer.
    enabled bool
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum number
    The maximum unit amount the customer can specify for this item.
    minimum number
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset number
    The starting unit amount which can be updated by the customer.
    enabled Boolean
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum Double
    The maximum unit amount the customer can specify for this item.
    minimum Double
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset Double
    The starting unit amount which can be updated by the customer.
    enabled boolean
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum number
    The maximum unit amount the customer can specify for this item.
    minimum number
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset number
    The starting unit amount which can be updated by the customer.
    enabled bool
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum float
    The maximum unit amount the customer can specify for this item.
    minimum float
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset float
    The starting unit amount which can be updated by the customer.
    enabled Boolean
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum Number
    The maximum unit amount the customer can specify for this item.
    minimum Number
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset Number
    The starting unit amount which can be updated by the customer.

    ProductDefaultPriceDataCurrencyOptionTier, ProductDefaultPriceDataCurrencyOptionTierArgs

    UpTo double
    Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.
    FlatAmount double
    The flat billing amount for an entire tier, regardless of the number of units in the tier.
    FlatAmountDecimal string
    Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.
    UnitAmount double
    The per unit billing amount for each individual unit for which this tier applies.
    UnitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    UpTo float64
    Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.
    FlatAmount float64
    The flat billing amount for an entire tier, regardless of the number of units in the tier.
    FlatAmountDecimal string
    Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.
    UnitAmount float64
    The per unit billing amount for each individual unit for which this tier applies.
    UnitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    up_to number
    Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.
    flat_amount number
    The flat billing amount for an entire tier, regardless of the number of units in the tier.
    flat_amount_decimal string
    Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.
    unit_amount number
    The per unit billing amount for each individual unit for which this tier applies.
    unit_amount_decimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    upTo Double
    Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.
    flatAmount Double
    The flat billing amount for an entire tier, regardless of the number of units in the tier.
    flatAmountDecimal String
    Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.
    unitAmount Double
    The per unit billing amount for each individual unit for which this tier applies.
    unitAmountDecimal String
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    upTo number
    Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.
    flatAmount number
    The flat billing amount for an entire tier, regardless of the number of units in the tier.
    flatAmountDecimal string
    Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.
    unitAmount number
    The per unit billing amount for each individual unit for which this tier applies.
    unitAmountDecimal string
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    up_to float
    Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.
    flat_amount float
    The flat billing amount for an entire tier, regardless of the number of units in the tier.
    flat_amount_decimal str
    Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.
    unit_amount float
    The per unit billing amount for each individual unit for which this tier applies.
    unit_amount_decimal str
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    upTo Number
    Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.
    flatAmount Number
    The flat billing amount for an entire tier, regardless of the number of units in the tier.
    flatAmountDecimal String
    Same as flat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one of flat_amount and flat_amount_decimal can be set.
    unitAmount Number
    The per unit billing amount for each individual unit for which this tier applies.
    unitAmountDecimal String
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    ProductDefaultPriceDataCustomUnitAmount, ProductDefaultPriceDataCustomUnitAmountArgs

    Enabled bool
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    Maximum double
    The maximum unit amount the customer can specify for this item.
    Minimum double
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    Preset double
    The starting unit amount which can be updated by the customer.
    Enabled bool
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    Maximum float64
    The maximum unit amount the customer can specify for this item.
    Minimum float64
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    Preset float64
    The starting unit amount which can be updated by the customer.
    enabled bool
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum number
    The maximum unit amount the customer can specify for this item.
    minimum number
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset number
    The starting unit amount which can be updated by the customer.
    enabled Boolean
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum Double
    The maximum unit amount the customer can specify for this item.
    minimum Double
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset Double
    The starting unit amount which can be updated by the customer.
    enabled boolean
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum number
    The maximum unit amount the customer can specify for this item.
    minimum number
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset number
    The starting unit amount which can be updated by the customer.
    enabled bool
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum float
    The maximum unit amount the customer can specify for this item.
    minimum float
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset float
    The starting unit amount which can be updated by the customer.
    enabled Boolean
    Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount.
    maximum Number
    The maximum unit amount the customer can specify for this item.
    minimum Number
    The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
    preset Number
    The starting unit amount which can be updated by the customer.

    ProductDefaultPriceDataRecurring, ProductDefaultPriceDataRecurringArgs

    Interval string
    Specifies billing frequency. Either day, week, month or year.
    IntervalCount double
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    Interval string
    Specifies billing frequency. Either day, week, month or year.
    IntervalCount float64
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval string
    Specifies billing frequency. Either day, week, month or year.
    interval_count number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval String
    Specifies billing frequency. Either day, week, month or year.
    intervalCount Double
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval string
    Specifies billing frequency. Either day, week, month or year.
    intervalCount number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval str
    Specifies billing frequency. Either day, week, month or year.
    interval_count float
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
    interval String
    Specifies billing frequency. Either day, week, month or year.
    intervalCount Number
    The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

    ProductMarketingFeature, ProductMarketingFeatureArgs

    Name string
    The marketing feature name. Up to 80 characters long.
    Name string
    The marketing feature name. Up to 80 characters long.
    name string
    The marketing feature name. Up to 80 characters long.
    name String
    The marketing feature name. Up to 80 characters long.
    name string
    The marketing feature name. Up to 80 characters long.
    name str
    The marketing feature name. Up to 80 characters long.
    name String
    The marketing feature name. Up to 80 characters long.

    ProductPackageDimension, ProductPackageDimensionArgs

    Height double
    Height, in inches.
    Length double
    Length, in inches.
    Weight double
    Weight, in ounces.
    Width double
    Width, in inches.
    Height float64
    Height, in inches.
    Length float64
    Length, in inches.
    Weight float64
    Weight, in ounces.
    Width float64
    Width, in inches.
    height number
    Height, in inches.
    length number
    Length, in inches.
    weight number
    Weight, in ounces.
    width number
    Width, in inches.
    height Double
    Height, in inches.
    length Double
    Length, in inches.
    weight Double
    Weight, in ounces.
    width Double
    Width, in inches.
    height number
    Height, in inches.
    length number
    Length, in inches.
    weight number
    Weight, in ounces.
    width number
    Width, in inches.
    height float
    Height, in inches.
    length float
    Length, in inches.
    weight float
    Weight, in ounces.
    width float
    Width, in inches.
    height Number
    Height, in inches.
    length Number
    Length, in inches.
    weight Number
    Weight, in ounces.
    width Number
    Width, in inches.

    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