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

stripe.Price

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

    Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

    For example, you might have a single “gold” product that has prices for $10/month, $100/year, and €9 once.

    Related guides: Set up a subscription, create an invoice, and more about products and prices.

    Create Price Resource

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

    Constructor syntax

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

@overload
def Price(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          currency: Optional[str] = None,
          product: Optional[str] = None,
          recurrings: Optional[Sequence[PriceRecurringArgs]] = None,
          currency_options: Optional[Sequence[PriceCurrencyOptionArgs]] = None,
          custom_unit_amounts: Optional[Sequence[PriceCustomUnitAmountArgs]] = None,
          lookup_key: Optional[str] = None,
          metadata: Optional[Mapping[str, str]] = None,
          nickname: Optional[str] = None,
          active: Optional[bool] = None,
          billing_scheme: Optional[str] = None,
          tax_behavior: Optional[str] = None,
          product_datas: Optional[Sequence[PriceProductDataArgs]] = None,
          tiers: Optional[Sequence[PriceTierArgs]] = None,
          tiers_mode: Optional[str] = None,
          transfer_lookup_key: Optional[bool] = None,
          transform_quantity: Optional[PriceTransformQuantityArgs] = None,
          unit_amount: Optional[float] = None,
          unit_amount_decimal: Optional[str] = None)
    func NewPrice(ctx *Context, name string, args PriceArgs, opts ...ResourceOption) (*Price, error)
    public Price(string name, PriceArgs args, CustomResourceOptions? opts = null)
    public Price(String name, PriceArgs args)
public Price(String name, PriceArgs args, CustomResourceOptions options)

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


    resource "stripe_price" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PriceArgs
    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 PriceArgs
    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 PriceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PriceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PriceArgs
    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 priceResource = new Stripe.Price("priceResource", new()
{
    Currency = "string",
    Product = "string",
    Recurrings = new[]
    {
        new Stripe.Inputs.PriceRecurringArgs
        {
            Interval = "string",
            IntervalCount = 0.0,
            Meter = "string",
            TrialPeriodDays = 0.0,
            UsageType = "string",
        },
    },
    CurrencyOptions = new[]
    {
        new Stripe.Inputs.PriceCurrencyOptionArgs
        {
            Key = "string",
            CustomUnitAmounts = new[]
            {
                new Stripe.Inputs.PriceCurrencyOptionCustomUnitAmountArgs
                {
                    Enabled = false,
                    Maximum = 0.0,
                    Minimum = 0.0,
                    Preset = 0.0,
                },
            },
            TaxBehavior = "string",
            Tiers = new[]
            {
                new Stripe.Inputs.PriceCurrencyOptionTierArgs
                {
                    UpTo = "string",
                    FlatAmount = 0.0,
                    FlatAmountDecimal = "string",
                    UnitAmount = 0.0,
                    UnitAmountDecimal = "string",
                },
            },
            UnitAmount = 0.0,
            UnitAmountDecimal = "string",
        },
    },
    CustomUnitAmounts = new[]
    {
        new Stripe.Inputs.PriceCustomUnitAmountArgs
        {
            Enabled = false,
            Maximum = 0.0,
            Minimum = 0.0,
            Preset = 0.0,
        },
    },
    LookupKey = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Nickname = "string",
    Active = false,
    BillingScheme = "string",
    TaxBehavior = "string",
    ProductDatas = new[]
    {
        new Stripe.Inputs.PriceProductDataArgs
        {
            Name = "string",
            Active = false,
            Id = "string",
            Metadata = 
            {
                { "string", "string" },
            },
            StatementDescriptor = "string",
            TaxCode = "string",
            UnitLabel = "string",
        },
    },
    Tiers = new[]
    {
        new Stripe.Inputs.PriceTierArgs
        {
            UpTo = "string",
            FlatAmount = 0.0,
            FlatAmountDecimal = "string",
            UnitAmount = 0.0,
            UnitAmountDecimal = "string",
        },
    },
    TiersMode = "string",
    TransferLookupKey = false,
    TransformQuantity = new Stripe.Inputs.PriceTransformQuantityArgs
    {
        DivideBy = 0.0,
        Round = "string",
    },
    UnitAmount = 0.0,
    UnitAmountDecimal = "string",
});

    example, err := stripe.NewPrice(ctx, "priceResource", &stripe.PriceArgs{
	Currency: pulumi.String("string"),
	Product:  pulumi.String("string"),
	Recurrings: stripe.PriceRecurringArray{
		&stripe.PriceRecurringArgs{
			Interval:        pulumi.String("string"),
			IntervalCount:   pulumi.Float64(0),
			Meter:           pulumi.String("string"),
			TrialPeriodDays: pulumi.Float64(0),
			UsageType:       pulumi.String("string"),
		},
	},
	CurrencyOptions: stripe.PriceCurrencyOptionArray{
		&stripe.PriceCurrencyOptionArgs{
			Key: pulumi.String("string"),
			CustomUnitAmounts: stripe.PriceCurrencyOptionCustomUnitAmountArray{
				&stripe.PriceCurrencyOptionCustomUnitAmountArgs{
					Enabled: pulumi.Bool(false),
					Maximum: pulumi.Float64(0),
					Minimum: pulumi.Float64(0),
					Preset:  pulumi.Float64(0),
				},
			},
			TaxBehavior: pulumi.String("string"),
			Tiers: stripe.PriceCurrencyOptionTierArray{
				&stripe.PriceCurrencyOptionTierArgs{
					UpTo:              pulumi.String("string"),
					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.PriceCustomUnitAmountArray{
		&stripe.PriceCustomUnitAmountArgs{
			Enabled: pulumi.Bool(false),
			Maximum: pulumi.Float64(0),
			Minimum: pulumi.Float64(0),
			Preset:  pulumi.Float64(0),
		},
	},
	LookupKey: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Nickname:      pulumi.String("string"),
	Active:        pulumi.Bool(false),
	BillingScheme: pulumi.String("string"),
	TaxBehavior:   pulumi.String("string"),
	ProductDatas: stripe.PriceProductDataArray{
		&stripe.PriceProductDataArgs{
			Name:   pulumi.String("string"),
			Active: pulumi.Bool(false),
			Id:     pulumi.String("string"),
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			StatementDescriptor: pulumi.String("string"),
			TaxCode:             pulumi.String("string"),
			UnitLabel:           pulumi.String("string"),
		},
	},
	Tiers: stripe.PriceTierArray{
		&stripe.PriceTierArgs{
			UpTo:              pulumi.String("string"),
			FlatAmount:        pulumi.Float64(0),
			FlatAmountDecimal: pulumi.String("string"),
			UnitAmount:        pulumi.Float64(0),
			UnitAmountDecimal: pulumi.String("string"),
		},
	},
	TiersMode:         pulumi.String("string"),
	TransferLookupKey: pulumi.Bool(false),
	TransformQuantity: &stripe.PriceTransformQuantityArgs{
		DivideBy: pulumi.Float64(0),
		Round:    pulumi.String("string"),
	},
	UnitAmount:        pulumi.Float64(0),
	UnitAmountDecimal: pulumi.String("string"),
})

    resource "stripe_price" "priceResource" {
  lifecycle {
    create_before_destroy = true
  }
  currency = "string"
  product  = "string"
  recurrings {
    interval          = "string"
    interval_count    = 0
    meter             = "string"
    trial_period_days = 0
    usage_type        = "string"
  }
  currency_options {
    key = "string"
    custom_unit_amounts {
      enabled = false
      maximum = 0
      minimum = 0
      preset  = 0
    }
    tax_behavior = "string"
    tiers {
      up_to               = "string"
      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
  }
  lookup_key = "string"
  metadata = {
    "string" = "string"
  }
  nickname       = "string"
  active         = false
  billing_scheme = "string"
  tax_behavior   = "string"
  product_datas {
    name   = "string"
    active = false
    id     = "string"
    metadata = {
      "string" = "string"
    }
    statement_descriptor = "string"
    tax_code             = "string"
    unit_label           = "string"
  }
  tiers {
    up_to               = "string"
    flat_amount         = 0
    flat_amount_decimal = "string"
    unit_amount         = 0
    unit_amount_decimal = "string"
  }
  tiers_mode          = "string"
  transfer_lookup_key = false
  transform_quantity = {
    divide_by = 0
    round     = "string"
  }
  unit_amount         = 0
  unit_amount_decimal = "string"
}

    var priceResource = new Price("priceResource", PriceArgs.builder()
    .currency("string")
    .product("string")
    .recurrings(PriceRecurringArgs.builder()
        .interval("string")
        .intervalCount(0.0)
        .meter("string")
        .trialPeriodDays(0.0)
        .usageType("string")
        .build())
    .currencyOptions(PriceCurrencyOptionArgs.builder()
        .key("string")
        .customUnitAmounts(PriceCurrencyOptionCustomUnitAmountArgs.builder()
            .enabled(false)
            .maximum(0.0)
            .minimum(0.0)
            .preset(0.0)
            .build())
        .taxBehavior("string")
        .tiers(PriceCurrencyOptionTierArgs.builder()
            .upTo("string")
            .flatAmount(0.0)
            .flatAmountDecimal("string")
            .unitAmount(0.0)
            .unitAmountDecimal("string")
            .build())
        .unitAmount(0.0)
        .unitAmountDecimal("string")
        .build())
    .customUnitAmounts(PriceCustomUnitAmountArgs.builder()
        .enabled(false)
        .maximum(0.0)
        .minimum(0.0)
        .preset(0.0)
        .build())
    .lookupKey("string")
    .metadata(Map.of("string", "string"))
    .nickname("string")
    .active(false)
    .billingScheme("string")
    .taxBehavior("string")
    .productDatas(PriceProductDataArgs.builder()
        .name("string")
        .active(false)
        .id("string")
        .metadata(Map.of("string", "string"))
        .statementDescriptor("string")
        .taxCode("string")
        .unitLabel("string")
        .build())
    .tiers(PriceTierArgs.builder()
        .upTo("string")
        .flatAmount(0.0)
        .flatAmountDecimal("string")
        .unitAmount(0.0)
        .unitAmountDecimal("string")
        .build())
    .tiersMode("string")
    .transferLookupKey(false)
    .transformQuantity(PriceTransformQuantityArgs.builder()
        .divideBy(0.0)
        .round("string")
        .build())
    .unitAmount(0.0)
    .unitAmountDecimal("string")
    .build());

    price_resource = stripe.Price("priceResource",
    currency="string",
    product="string",
    recurrings=[{
        "interval": "string",
        "interval_count": float(0),
        "meter": "string",
        "trial_period_days": float(0),
        "usage_type": "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": "string",
            "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),
    }],
    lookup_key="string",
    metadata={
        "string": "string",
    },
    nickname="string",
    active=False,
    billing_scheme="string",
    tax_behavior="string",
    product_datas=[{
        "name": "string",
        "active": False,
        "id": "string",
        "metadata": {
            "string": "string",
        },
        "statement_descriptor": "string",
        "tax_code": "string",
        "unit_label": "string",
    }],
    tiers=[{
        "up_to": "string",
        "flat_amount": float(0),
        "flat_amount_decimal": "string",
        "unit_amount": float(0),
        "unit_amount_decimal": "string",
    }],
    tiers_mode="string",
    transfer_lookup_key=False,
    transform_quantity={
        "divide_by": float(0),
        "round": "string",
    },
    unit_amount=float(0),
    unit_amount_decimal="string")

    const priceResource = new stripe.Price("priceResource", {
    currency: "string",
    product: "string",
    recurrings: [{
        interval: "string",
        intervalCount: 0,
        meter: "string",
        trialPeriodDays: 0,
        usageType: "string",
    }],
    currencyOptions: [{
        key: "string",
        customUnitAmounts: [{
            enabled: false,
            maximum: 0,
            minimum: 0,
            preset: 0,
        }],
        taxBehavior: "string",
        tiers: [{
            upTo: "string",
            flatAmount: 0,
            flatAmountDecimal: "string",
            unitAmount: 0,
            unitAmountDecimal: "string",
        }],
        unitAmount: 0,
        unitAmountDecimal: "string",
    }],
    customUnitAmounts: [{
        enabled: false,
        maximum: 0,
        minimum: 0,
        preset: 0,
    }],
    lookupKey: "string",
    metadata: {
        string: "string",
    },
    nickname: "string",
    active: false,
    billingScheme: "string",
    taxBehavior: "string",
    productDatas: [{
        name: "string",
        active: false,
        id: "string",
        metadata: {
            string: "string",
        },
        statementDescriptor: "string",
        taxCode: "string",
        unitLabel: "string",
    }],
    tiers: [{
        upTo: "string",
        flatAmount: 0,
        flatAmountDecimal: "string",
        unitAmount: 0,
        unitAmountDecimal: "string",
    }],
    tiersMode: "string",
    transferLookupKey: false,
    transformQuantity: {
        divideBy: 0,
        round: "string",
    },
    unitAmount: 0,
    unitAmountDecimal: "string",
});

    type: stripe:Price
properties:
    active: false
    billingScheme: string
    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: string
          unitAmount: 0
          unitAmountDecimal: string
    customUnitAmounts:
        - enabled: false
          maximum: 0
          minimum: 0
          preset: 0
    lookupKey: string
    metadata:
        string: string
    nickname: string
    product: string
    productDatas:
        - active: false
          id: string
          metadata:
            string: string
          name: string
          statementDescriptor: string
          taxCode: string
          unitLabel: string
    recurrings:
        - interval: string
          intervalCount: 0
          meter: string
          trialPeriodDays: 0
          usageType: string
    taxBehavior: string
    tiers:
        - flatAmount: 0
          flatAmountDecimal: string
          unitAmount: 0
          unitAmountDecimal: string
          upTo: string
    tiersMode: string
    transferLookupKey: false
    transformQuantity:
        divideBy: 0
        round: string
    unitAmount: 0
    unitAmountDecimal: string

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

    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Active bool
    Whether the price can be used for new purchases.
    BillingScheme string
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    CurrencyOptions List<PriceCurrencyOption>
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    CustomUnitAmounts List<PriceCustomUnitAmount>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    LookupKey string
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    Nickname string
    A brief description of the price, hidden from customers.
    Product string
    The ID of the product this price is associated with.
    ProductDatas List<PriceProductData>
    These fields can be used to create a new product that this price will belong to.
    Recurrings List<PriceRecurring>
    The recurring components of a price such as interval and usage_type.
    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<PriceTier>
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    TiersMode string
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    TransferLookupKey bool
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    TransformQuantity PriceTransformQuantity
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    UnitAmount double
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    UnitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Active bool
    Whether the price can be used for new purchases.
    BillingScheme string
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    CurrencyOptions []PriceCurrencyOptionArgs
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    CustomUnitAmounts []PriceCustomUnitAmountArgs
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    LookupKey string
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    Nickname string
    A brief description of the price, hidden from customers.
    Product string
    The ID of the product this price is associated with.
    ProductDatas []PriceProductDataArgs
    These fields can be used to create a new product that this price will belong to.
    Recurrings []PriceRecurringArgs
    The recurring components of a price such as interval and usage_type.
    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 []PriceTierArgs
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    TiersMode string
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    TransferLookupKey bool
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    TransformQuantity PriceTransformQuantityArgs
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    UnitAmount float64
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    UnitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    active bool
    Whether the price can be used for new purchases.
    billing_scheme string
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    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.
    lookup_key string
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname string
    A brief description of the price, hidden from customers.
    product string
    The ID of the product this price is associated with.
    product_datas list(object)
    These fields can be used to create a new product that this price will belong to.
    recurrings list(object)
    The recurring components of a price such as interval and usage_type.
    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.
    tiers_mode string
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transfer_lookup_key bool
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transform_quantity object
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    unit_amount number
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unit_amount_decimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    active Boolean
    Whether the price can be used for new purchases.
    billingScheme String
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    currencyOptions List<PriceCurrencyOption>
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    customUnitAmounts List<PriceCustomUnitAmount>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    lookupKey String
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname String
    A brief description of the price, hidden from customers.
    product String
    The ID of the product this price is associated with.
    productDatas List<PriceProductData>
    These fields can be used to create a new product that this price will belong to.
    recurrings List<PriceRecurring>
    The recurring components of a price such as interval and usage_type.
    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<PriceTier>
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    tiersMode String
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transferLookupKey Boolean
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transformQuantity PriceTransformQuantity
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    unitAmount Double
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal String
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    active boolean
    Whether the price can be used for new purchases.
    billingScheme string
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    currencyOptions PriceCurrencyOption[]
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    customUnitAmounts PriceCustomUnitAmount[]
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    lookupKey string
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname string
    A brief description of the price, hidden from customers.
    product string
    The ID of the product this price is associated with.
    productDatas PriceProductData[]
    These fields can be used to create a new product that this price will belong to.
    recurrings PriceRecurring[]
    The recurring components of a price such as interval and usage_type.
    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 PriceTier[]
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    tiersMode string
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transferLookupKey boolean
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transformQuantity PriceTransformQuantity
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    unitAmount number
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    active bool
    Whether the price can be used for new purchases.
    billing_scheme str
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    currency_options Sequence[PriceCurrencyOptionArgs]
    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[PriceCustomUnitAmountArgs]
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    lookup_key str
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname str
    A brief description of the price, hidden from customers.
    product str
    The ID of the product this price is associated with.
    product_datas Sequence[PriceProductDataArgs]
    These fields can be used to create a new product that this price will belong to.
    recurrings Sequence[PriceRecurringArgs]
    The recurring components of a price such as interval and usage_type.
    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[PriceTierArgs]
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    tiers_mode str
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transfer_lookup_key bool
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transform_quantity PriceTransformQuantityArgs
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    unit_amount float
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unit_amount_decimal str
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    active Boolean
    Whether the price can be used for new purchases.
    billingScheme String
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    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.
    lookupKey String
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname String
    A brief description of the price, hidden from customers.
    product String
    The ID of the product this price is associated with.
    productDatas List<Property Map>
    These fields can be used to create a new product that this price will belong to.
    recurrings List<Property Map>
    The recurring components of a price such as interval and usage_type.
    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.
    tiersMode String
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transferLookupKey Boolean
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transformQuantity Property Map
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    unitAmount Number
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal String
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Price 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.
    Type string
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    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.
    Type string
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    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.
    type string
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    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.
    type String
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    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.
    type string
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    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.
    type str
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    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.
    type String
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

    Look up Existing Price Resource

    Get an existing Price 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?: PriceState, opts?: CustomResourceOptions): Price
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        billing_scheme: Optional[str] = None,
        created: Optional[float] = None,
        currency: Optional[str] = None,
        currency_options: Optional[Sequence[PriceCurrencyOptionArgs]] = None,
        custom_unit_amounts: Optional[Sequence[PriceCustomUnitAmountArgs]] = None,
        livemode: Optional[bool] = None,
        lookup_key: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        nickname: Optional[str] = None,
        object: Optional[str] = None,
        product: Optional[str] = None,
        product_datas: Optional[Sequence[PriceProductDataArgs]] = None,
        recurrings: Optional[Sequence[PriceRecurringArgs]] = None,
        tax_behavior: Optional[str] = None,
        tiers: Optional[Sequence[PriceTierArgs]] = None,
        tiers_mode: Optional[str] = None,
        transfer_lookup_key: Optional[bool] = None,
        transform_quantity: Optional[PriceTransformQuantityArgs] = None,
        type: Optional[str] = None,
        unit_amount: Optional[float] = None,
        unit_amount_decimal: Optional[str] = None) -> Price
    func GetPrice(ctx *Context, name string, id IDInput, state *PriceState, opts ...ResourceOption) (*Price, error)
    public static Price Get(string name, Input<string> id, PriceState? state, CustomResourceOptions? opts = null)
    public static Price get(String name, Output<String> id, PriceState state, CustomResourceOptions options)
    resources:  _:    type: stripe:Price    get:      id: ${id}
    import {
  to = stripe_price.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 price can be used for new purchases.
    BillingScheme string
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CurrencyOptions List<PriceCurrencyOption>
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    CustomUnitAmounts List<PriceCustomUnitAmount>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    LookupKey string
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    Nickname string
    A brief description of the price, hidden from customers.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Product string
    The ID of the product this price is associated with.
    ProductDatas List<PriceProductData>
    These fields can be used to create a new product that this price will belong to.
    Recurrings List<PriceRecurring>
    The recurring components of a price such as interval and usage_type.
    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<PriceTier>
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    TiersMode string
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    TransferLookupKey bool
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    TransformQuantity PriceTransformQuantity
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    Type string
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    UnitAmount double
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    UnitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    Active bool
    Whether the price can be used for new purchases.
    BillingScheme string
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CurrencyOptions []PriceCurrencyOptionArgs
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    CustomUnitAmounts []PriceCustomUnitAmountArgs
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    LookupKey string
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    Nickname string
    A brief description of the price, hidden from customers.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Product string
    The ID of the product this price is associated with.
    ProductDatas []PriceProductDataArgs
    These fields can be used to create a new product that this price will belong to.
    Recurrings []PriceRecurringArgs
    The recurring components of a price such as interval and usage_type.
    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 []PriceTierArgs
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    TiersMode string
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    TransferLookupKey bool
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    TransformQuantity PriceTransformQuantityArgs
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    Type string
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    UnitAmount float64
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    UnitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    active bool
    Whether the price can be used for new purchases.
    billing_scheme string
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    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.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookup_key string
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname string
    A brief description of the price, hidden from customers.
    object string
    String representing the object's type. Objects of the same type share the same value.
    product string
    The ID of the product this price is associated with.
    product_datas list(object)
    These fields can be used to create a new product that this price will belong to.
    recurrings list(object)
    The recurring components of a price such as interval and usage_type.
    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.
    tiers_mode string
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transfer_lookup_key bool
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transform_quantity object
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    type string
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    unit_amount number
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unit_amount_decimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    active Boolean
    Whether the price can be used for new purchases.
    billingScheme String
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions List<PriceCurrencyOption>
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    customUnitAmounts List<PriceCustomUnitAmount>
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookupKey String
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname String
    A brief description of the price, hidden from customers.
    object String
    String representing the object's type. Objects of the same type share the same value.
    product String
    The ID of the product this price is associated with.
    productDatas List<PriceProductData>
    These fields can be used to create a new product that this price will belong to.
    recurrings List<PriceRecurring>
    The recurring components of a price such as interval and usage_type.
    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<PriceTier>
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    tiersMode String
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transferLookupKey Boolean
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transformQuantity PriceTransformQuantity
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    type String
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    unitAmount Double
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal String
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    active boolean
    Whether the price can be used for new purchases.
    billingScheme string
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions PriceCurrencyOption[]
    Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    customUnitAmounts PriceCustomUnitAmount[]
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookupKey string
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname string
    A brief description of the price, hidden from customers.
    object string
    String representing the object's type. Objects of the same type share the same value.
    product string
    The ID of the product this price is associated with.
    productDatas PriceProductData[]
    These fields can be used to create a new product that this price will belong to.
    recurrings PriceRecurring[]
    The recurring components of a price such as interval and usage_type.
    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 PriceTier[]
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    tiersMode string
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transferLookupKey boolean
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transformQuantity PriceTransformQuantity
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    type string
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    unitAmount number
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    active bool
    Whether the price can be used for new purchases.
    billing_scheme str
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currency_options Sequence[PriceCurrencyOptionArgs]
    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[PriceCustomUnitAmountArgs]
    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookup_key str
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname str
    A brief description of the price, hidden from customers.
    object str
    String representing the object's type. Objects of the same type share the same value.
    product str
    The ID of the product this price is associated with.
    product_datas Sequence[PriceProductDataArgs]
    These fields can be used to create a new product that this price will belong to.
    recurrings Sequence[PriceRecurringArgs]
    The recurring components of a price such as interval and usage_type.
    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[PriceTierArgs]
    Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.
    tiers_mode str
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transfer_lookup_key bool
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transform_quantity PriceTransformQuantityArgs
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    type str
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    unit_amount float
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unit_amount_decimal str
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    active Boolean
    Whether the price can be used for new purchases.
    billingScheme String
    Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    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.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    lookupKey String
    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
    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.
    nickname String
    A brief description of the price, hidden from customers.
    object String
    String representing the object's type. Objects of the same type share the same value.
    product String
    The ID of the product this price is associated with.
    productDatas List<Property Map>
    These fields can be used to create a new product that this price will belong to.
    recurrings List<Property Map>
    The recurring components of a price such as interval and usage_type.
    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.
    tiersMode String
    Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.
    transferLookupKey Boolean
    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
    transformQuantity Property Map
    Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.
    type String
    One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
    unitAmount Number
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal String
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

    Supporting Types

    PriceCurrencyOption, PriceCurrencyOptionArgs

    Key string
    Key for this entry.
    CustomUnitAmounts List<PriceCurrencyOptionCustomUnitAmount>
    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<PriceCurrencyOptionTier>
    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
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    UnitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    Key string
    Key for this entry.
    CustomUnitAmounts []PriceCurrencyOptionCustomUnitAmount
    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 []PriceCurrencyOptionTier
    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
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    UnitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    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
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unit_amount_decimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    key String
    Key for this entry.
    customUnitAmounts List<PriceCurrencyOptionCustomUnitAmount>
    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<PriceCurrencyOptionTier>
    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
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal String
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    key string
    Key for this entry.
    customUnitAmounts PriceCurrencyOptionCustomUnitAmount[]
    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 PriceCurrencyOptionTier[]
    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
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal string
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    key str
    Key for this entry.
    custom_unit_amounts Sequence[PriceCurrencyOptionCustomUnitAmount]
    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[PriceCurrencyOptionTier]
    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
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unit_amount_decimal str
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
    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
    The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
    unitAmountDecimal String
    The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

    PriceCurrencyOptionCustomUnitAmount, PriceCurrencyOptionCustomUnitAmountArgs

    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.

    PriceCurrencyOptionTier, PriceCurrencyOptionTierArgs

    UpTo string
    Up to and including to this quantity will be contained in the tier.
    FlatAmount double
    Price for the entire tier.
    FlatAmountDecimal string
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    UnitAmount double
    Per unit price for units relevant to the tier.
    UnitAmountDecimal string
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    UpTo string
    Up to and including to this quantity will be contained in the tier.
    FlatAmount float64
    Price for the entire tier.
    FlatAmountDecimal string
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    UnitAmount float64
    Per unit price for units relevant to the tier.
    UnitAmountDecimal string
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    up_to string
    Up to and including to this quantity will be contained in the tier.
    flat_amount number
    Price for the entire tier.
    flat_amount_decimal string
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unit_amount number
    Per unit price for units relevant to the tier.
    unit_amount_decimal string
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    upTo String
    Up to and including to this quantity will be contained in the tier.
    flatAmount Double
    Price for the entire tier.
    flatAmountDecimal String
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unitAmount Double
    Per unit price for units relevant to the tier.
    unitAmountDecimal String
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    upTo string
    Up to and including to this quantity will be contained in the tier.
    flatAmount number
    Price for the entire tier.
    flatAmountDecimal string
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unitAmount number
    Per unit price for units relevant to the tier.
    unitAmountDecimal string
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    up_to str
    Up to and including to this quantity will be contained in the tier.
    flat_amount float
    Price for the entire tier.
    flat_amount_decimal str
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unit_amount float
    Per unit price for units relevant to the tier.
    unit_amount_decimal str
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    upTo String
    Up to and including to this quantity will be contained in the tier.
    flatAmount Number
    Price for the entire tier.
    flatAmountDecimal String
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unitAmount Number
    Per unit price for units relevant to the tier.
    unitAmountDecimal String
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.

    PriceCustomUnitAmount, PriceCustomUnitAmountArgs

    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.

    PriceProductData, PriceProductDataArgs

    Name string
    The product's name, meant to be displayable to the customer.
    Active bool
    Whether the product is currently available for purchase. Defaults to true.
    Id string
    The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
    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.
    StatementDescriptor string
    An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
    TaxCode string
    A tax code ID.
    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.
    Name string
    The product's name, meant to be displayable to the customer.
    Active bool
    Whether the product is currently available for purchase. Defaults to true.
    Id string
    The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
    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.
    StatementDescriptor string
    An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
    TaxCode string
    A tax code ID.
    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.
    name string
    The product's name, meant to be displayable to the customer.
    active bool
    Whether the product is currently available for purchase. Defaults to true.
    id string
    The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
    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.
    statement_descriptor string
    An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
    tax_code string
    A tax code ID.
    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.
    name String
    The product's name, meant to be displayable to the customer.
    active Boolean
    Whether the product is currently available for purchase. Defaults to true.
    id String
    The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
    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.
    statementDescriptor String
    An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
    taxCode String
    A tax code ID.
    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.
    name string
    The product's name, meant to be displayable to the customer.
    active boolean
    Whether the product is currently available for purchase. Defaults to true.
    id string
    The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
    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.
    statementDescriptor string
    An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
    taxCode string
    A tax code ID.
    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.
    name str
    The product's name, meant to be displayable to the customer.
    active bool
    Whether the product is currently available for purchase. Defaults to true.
    id str
    The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
    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.
    statement_descriptor str
    An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
    tax_code str
    A tax code ID.
    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.
    name String
    The product's name, meant to be displayable to the customer.
    active Boolean
    Whether the product is currently available for purchase. Defaults to true.
    id String
    The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
    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.
    statementDescriptor String
    An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
    taxCode String
    A tax code ID.
    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.

    PriceRecurring, PriceRecurringArgs

    Interval string
    The frequency at which a subscription is billed. One of day, week, month or year.
    IntervalCount double
    The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
    Meter string
    The meter tracking the usage of a metered price
    TrialPeriodDays double
    Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
    UsageType string
    Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
    Interval string
    The frequency at which a subscription is billed. One of day, week, month or year.
    IntervalCount float64
    The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
    Meter string
    The meter tracking the usage of a metered price
    TrialPeriodDays float64
    Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
    UsageType string
    Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
    interval string
    The frequency at which a subscription is billed. One of day, week, month or year.
    interval_count number
    The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
    meter string
    The meter tracking the usage of a metered price
    trial_period_days number
    Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
    usage_type string
    Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
    interval String
    The frequency at which a subscription is billed. One of day, week, month or year.
    intervalCount Double
    The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
    meter String
    The meter tracking the usage of a metered price
    trialPeriodDays Double
    Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
    usageType String
    Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
    interval string
    The frequency at which a subscription is billed. One of day, week, month or year.
    intervalCount number
    The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
    meter string
    The meter tracking the usage of a metered price
    trialPeriodDays number
    Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
    usageType string
    Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
    interval str
    The frequency at which a subscription is billed. One of day, week, month or year.
    interval_count float
    The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
    meter str
    The meter tracking the usage of a metered price
    trial_period_days float
    Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
    usage_type str
    Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.
    interval String
    The frequency at which a subscription is billed. One of day, week, month or year.
    intervalCount Number
    The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
    meter String
    The meter tracking the usage of a metered price
    trialPeriodDays Number
    Default number of trial days when subscribing a customer to this price using trial_from_plan=true.
    usageType String
    Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

    PriceTier, PriceTierArgs

    UpTo string
    Up to and including to this quantity will be contained in the tier.
    FlatAmount double
    Price for the entire tier.
    FlatAmountDecimal string
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    UnitAmount double
    Per unit price for units relevant to the tier.
    UnitAmountDecimal string
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    UpTo string
    Up to and including to this quantity will be contained in the tier.
    FlatAmount float64
    Price for the entire tier.
    FlatAmountDecimal string
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    UnitAmount float64
    Per unit price for units relevant to the tier.
    UnitAmountDecimal string
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    up_to string
    Up to and including to this quantity will be contained in the tier.
    flat_amount number
    Price for the entire tier.
    flat_amount_decimal string
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unit_amount number
    Per unit price for units relevant to the tier.
    unit_amount_decimal string
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    upTo String
    Up to and including to this quantity will be contained in the tier.
    flatAmount Double
    Price for the entire tier.
    flatAmountDecimal String
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unitAmount Double
    Per unit price for units relevant to the tier.
    unitAmountDecimal String
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    upTo string
    Up to and including to this quantity will be contained in the tier.
    flatAmount number
    Price for the entire tier.
    flatAmountDecimal string
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unitAmount number
    Per unit price for units relevant to the tier.
    unitAmountDecimal string
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    up_to str
    Up to and including to this quantity will be contained in the tier.
    flat_amount float
    Price for the entire tier.
    flat_amount_decimal str
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unit_amount float
    Per unit price for units relevant to the tier.
    unit_amount_decimal str
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.
    upTo String
    Up to and including to this quantity will be contained in the tier.
    flatAmount Number
    Price for the entire tier.
    flatAmountDecimal String
    Same as flat_amount, but contains a decimal value with at most 12 decimal places.
    unitAmount Number
    Per unit price for units relevant to the tier.
    unitAmountDecimal String
    Same as unit_amount, but contains a decimal value with at most 12 decimal places.

    PriceTransformQuantity, PriceTransformQuantityArgs

    DivideBy double
    Divide usage by this number.
    Round string
    After division, either round the result up or down.
    DivideBy float64
    Divide usage by this number.
    Round string
    After division, either round the result up or down.
    divide_by number
    Divide usage by this number.
    round string
    After division, either round the result up or down.
    divideBy Double
    Divide usage by this number.
    round String
    After division, either round the result up or down.
    divideBy number
    Divide usage by this number.
    round string
    After division, either round the result up or down.
    divide_by float
    Divide usage by this number.
    round str
    After division, either round the result up or down.
    divideBy Number
    Divide usage by this number.
    round String
    After division, either round the result up or down.

    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