published on Friday, Aug 14, 2026 by Pulumi
published on Friday, Aug 14, 2026 by Pulumi
Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
Create SubscriptionItem Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SubscriptionItem(name: string, args: SubscriptionItemArgs, opts?: CustomResourceOptions);@overload
def SubscriptionItem(resource_name: str,
args: SubscriptionItemInitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SubscriptionItem(resource_name: str,
opts: Optional[ResourceOptions] = None,
subscription: Optional[str] = None,
billing_thresholds: Optional[SubscriptionItemBillingThresholdsArgs] = None,
discounts: Optional[Sequence[SubscriptionItemDiscountArgs]] = None,
metadata: Optional[Mapping[str, str]] = None,
payment_behavior: Optional[str] = None,
plan: Optional[str] = None,
price: Optional[str] = None,
price_data: Optional[SubscriptionItemPriceDataArgs] = None,
proration_behavior: Optional[str] = None,
proration_date: Optional[float] = None,
quantity: Optional[float] = None,
tax_rates: Optional[Sequence[str]] = None)func NewSubscriptionItem(ctx *Context, name string, args SubscriptionItemArgs, opts ...ResourceOption) (*SubscriptionItem, error)public SubscriptionItem(string name, SubscriptionItemArgs args, CustomResourceOptions? opts = null)
public SubscriptionItem(String name, SubscriptionItemArgs args)
public SubscriptionItem(String name, SubscriptionItemArgs args, CustomResourceOptions options)
type: stripe:SubscriptionItem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "stripe_subscription_item" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SubscriptionItemArgs
- 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 SubscriptionItemInitArgs
- 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 SubscriptionItemArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriptionItemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubscriptionItemArgs
- 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 subscriptionItemResource = new Stripe.SubscriptionItem("subscriptionItemResource", new()
{
Subscription = "string",
BillingThresholds = new Stripe.Inputs.SubscriptionItemBillingThresholdsArgs
{
UsageGte = 0.0,
},
Discounts = new[]
{
new Stripe.Inputs.SubscriptionItemDiscountArgs
{
Coupon = "string",
Discount = "string",
PromotionCode = "string",
},
},
Metadata =
{
{ "string", "string" },
},
PaymentBehavior = "string",
Plan = "string",
Price = "string",
PriceData = new Stripe.Inputs.SubscriptionItemPriceDataArgs
{
Currency = "string",
Product = "string",
Recurring = new Stripe.Inputs.SubscriptionItemPriceDataRecurringArgs
{
Interval = "string",
IntervalCount = 0.0,
},
TaxBehavior = "string",
UnitAmount = 0.0,
UnitAmountDecimal = 0.0,
},
ProrationBehavior = "string",
ProrationDate = 0.0,
Quantity = 0.0,
TaxRates = new[]
{
"string",
},
});
example, err := stripe.NewSubscriptionItem(ctx, "subscriptionItemResource", &stripe.SubscriptionItemArgs{
Subscription: pulumi.String("string"),
BillingThresholds: &stripe.SubscriptionItemBillingThresholdsArgs{
UsageGte: pulumi.Float64(0),
},
Discounts: stripe.SubscriptionItemDiscountArray{
&stripe.SubscriptionItemDiscountArgs{
Coupon: pulumi.String("string"),
Discount: pulumi.String("string"),
PromotionCode: pulumi.String("string"),
},
},
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
PaymentBehavior: pulumi.String("string"),
Plan: pulumi.String("string"),
Price: pulumi.String("string"),
PriceData: &stripe.SubscriptionItemPriceDataArgs{
Currency: pulumi.String("string"),
Product: pulumi.String("string"),
Recurring: &stripe.SubscriptionItemPriceDataRecurringArgs{
Interval: pulumi.String("string"),
IntervalCount: pulumi.Float64(0),
},
TaxBehavior: pulumi.String("string"),
UnitAmount: pulumi.Float64(0),
UnitAmountDecimal: pulumi.Float64(0),
},
ProrationBehavior: pulumi.String("string"),
ProrationDate: pulumi.Float64(0),
Quantity: pulumi.Float64(0),
TaxRates: pulumi.StringArray{
pulumi.String("string"),
},
})
resource "stripe_subscription_item" "subscriptionItemResource" {
lifecycle {
create_before_destroy = true
}
subscription = "string"
billing_thresholds = {
usage_gte = 0
}
discounts {
coupon = "string"
discount = "string"
promotion_code = "string"
}
metadata = {
"string" = "string"
}
payment_behavior = "string"
plan = "string"
price = "string"
price_data = {
currency = "string"
product = "string"
recurring = {
interval = "string"
interval_count = 0
}
tax_behavior = "string"
unit_amount = 0
unit_amount_decimal = 0
}
proration_behavior = "string"
proration_date = 0
quantity = 0
tax_rates = ["string"]
}
var subscriptionItemResource = new SubscriptionItem("subscriptionItemResource", SubscriptionItemArgs.builder()
.subscription("string")
.billingThresholds(SubscriptionItemBillingThresholdsArgs.builder()
.usageGte(0.0)
.build())
.discounts(SubscriptionItemDiscountArgs.builder()
.coupon("string")
.discount("string")
.promotionCode("string")
.build())
.metadata(Map.of("string", "string"))
.paymentBehavior("string")
.plan("string")
.price("string")
.priceData(SubscriptionItemPriceDataArgs.builder()
.currency("string")
.product("string")
.recurring(SubscriptionItemPriceDataRecurringArgs.builder()
.interval("string")
.intervalCount(0.0)
.build())
.taxBehavior("string")
.unitAmount(0.0)
.unitAmountDecimal(0.0)
.build())
.prorationBehavior("string")
.prorationDate(0.0)
.quantity(0.0)
.taxRates("string")
.build());
subscription_item_resource = stripe.SubscriptionItem("subscriptionItemResource",
subscription="string",
billing_thresholds={
"usage_gte": float(0),
},
discounts=[{
"coupon": "string",
"discount": "string",
"promotion_code": "string",
}],
metadata={
"string": "string",
},
payment_behavior="string",
plan="string",
price="string",
price_data={
"currency": "string",
"product": "string",
"recurring": {
"interval": "string",
"interval_count": float(0),
},
"tax_behavior": "string",
"unit_amount": float(0),
"unit_amount_decimal": float(0),
},
proration_behavior="string",
proration_date=float(0),
quantity=float(0),
tax_rates=["string"])
const subscriptionItemResource = new stripe.SubscriptionItem("subscriptionItemResource", {
subscription: "string",
billingThresholds: {
usageGte: 0,
},
discounts: [{
coupon: "string",
discount: "string",
promotionCode: "string",
}],
metadata: {
string: "string",
},
paymentBehavior: "string",
plan: "string",
price: "string",
priceData: {
currency: "string",
product: "string",
recurring: {
interval: "string",
intervalCount: 0,
},
taxBehavior: "string",
unitAmount: 0,
unitAmountDecimal: 0,
},
prorationBehavior: "string",
prorationDate: 0,
quantity: 0,
taxRates: ["string"],
});
type: stripe:SubscriptionItem
properties:
billingThresholds:
usageGte: 0
discounts:
- coupon: string
discount: string
promotionCode: string
metadata:
string: string
paymentBehavior: string
plan: string
price: string
priceData:
currency: string
product: string
recurring:
interval: string
intervalCount: 0
taxBehavior: string
unitAmount: 0
unitAmountDecimal: 0
prorationBehavior: string
prorationDate: 0
quantity: 0
subscription: string
taxRates:
- string
SubscriptionItem 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 SubscriptionItem resource accepts the following input properties:
- Subscription string
- The
subscriptionthissubscription_itembelongs to. - Billing
Thresholds SubscriptionItem Billing Thresholds - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- Discounts
List<Subscription
Item Discount> - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - 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.
- Payment
Behavior string - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - Plan string
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- Price string
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.
- Price
Data SubscriptionItem Price Data - Data used to generate a new Price object inline.
- Proration
Behavior string - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - Proration
Date double - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- Quantity double
- The quantity of the plan to which the customer should be subscribed.
- Tax
Rates List<string> - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- Subscription string
- The
subscriptionthissubscription_itembelongs to. - Billing
Thresholds SubscriptionItem Billing Thresholds Args - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- Discounts
[]Subscription
Item Discount Args - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - 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.
- Payment
Behavior string - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - Plan string
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- Price string
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.
- Price
Data SubscriptionItem Price Data Args - Data used to generate a new Price object inline.
- Proration
Behavior string - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - Proration
Date float64 - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- Quantity float64
- The quantity of the plan to which the customer should be subscribed.
- Tax
Rates []string - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- subscription string
- The
subscriptionthissubscription_itembelongs to. - billing_
thresholds object - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- discounts list(object)
- The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - 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.
- payment_
behavior string - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan string
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price string
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.
- price_
data object - Data used to generate a new Price object inline.
- proration_
behavior string - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration_
date number - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity number
- The quantity of the plan to which the customer should be subscribed.
- tax_
rates list(string) - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- subscription String
- The
subscriptionthissubscription_itembelongs to. - billing
Thresholds SubscriptionItem Billing Thresholds - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- discounts
List<Subscription
Item Discount> - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - 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.
- payment
Behavior String - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan String
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price String
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.
- price
Data SubscriptionItem Price Data - Data used to generate a new Price object inline.
- proration
Behavior String - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration
Date Double - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity Double
- The quantity of the plan to which the customer should be subscribed.
- tax
Rates List<String> - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- subscription string
- The
subscriptionthissubscription_itembelongs to. - billing
Thresholds SubscriptionItem Billing Thresholds - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- discounts
Subscription
Item Discount[] - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - 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.
- payment
Behavior string - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan string
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price string
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.
- price
Data SubscriptionItem Price Data - Data used to generate a new Price object inline.
- proration
Behavior string - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration
Date number - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity number
- The quantity of the plan to which the customer should be subscribed.
- tax
Rates string[] - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- subscription str
- The
subscriptionthissubscription_itembelongs to. - billing_
thresholds SubscriptionItem Billing Thresholds Args - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- discounts
Sequence[Subscription
Item Discount Args] - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - 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.
- payment_
behavior str - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan str
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price str
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.
- price_
data SubscriptionItem Price Data Args - Data used to generate a new Price object inline.
- proration_
behavior str - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration_
date float - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity float
- The quantity of the plan to which the customer should be subscribed.
- tax_
rates Sequence[str] - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- subscription String
- The
subscriptionthissubscription_itembelongs to. - billing
Thresholds Property Map - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- discounts List<Property Map>
- The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - 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.
- payment
Behavior String - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan String
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price String
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.
- price
Data Property Map - Data used to generate a new Price object inline.
- proration
Behavior String - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration
Date Number - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity Number
- The quantity of the plan to which the customer should be subscribed.
- tax
Rates List<String> - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
Outputs
All input properties are implicitly available as output properties. Additionally, the SubscriptionItem resource produces the following output properties:
- Billed
Until double - The time period the subscription item has been billed for.
- Created double
- Time at which the object was created. Measured in seconds since the Unix epoch.
- Current
Period doubleEnd - The end time of this subscription item's current billing period.
- Current
Period doubleStart - The start time of this subscription item's current billing period.
- Id string
- The provider-assigned unique ID for this managed resource.
- Object string
- String representing the object's type. Objects of the same type share the same value.
- Billed
Until float64 - The time period the subscription item has been billed for.
- Created float64
- Time at which the object was created. Measured in seconds since the Unix epoch.
- Current
Period float64End - The end time of this subscription item's current billing period.
- Current
Period float64Start - The start time of this subscription item's current billing period.
- Id string
- The provider-assigned unique ID for this managed resource.
- Object string
- String representing the object's type. Objects of the same type share the same value.
- billed_
until number - The time period the subscription item has been billed for.
- created number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current_
period_ numberend - The end time of this subscription item's current billing period.
- current_
period_ numberstart - The start time of this subscription item's current billing period.
- id string
- The provider-assigned unique ID for this managed resource.
- object string
- String representing the object's type. Objects of the same type share the same value.
- billed
Until Double - The time period the subscription item has been billed for.
- created Double
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current
Period DoubleEnd - The end time of this subscription item's current billing period.
- current
Period DoubleStart - The start time of this subscription item's current billing period.
- id String
- The provider-assigned unique ID for this managed resource.
- object String
- String representing the object's type. Objects of the same type share the same value.
- billed
Until number - The time period the subscription item has been billed for.
- created number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current
Period numberEnd - The end time of this subscription item's current billing period.
- current
Period numberStart - The start time of this subscription item's current billing period.
- id string
- The provider-assigned unique ID for this managed resource.
- object string
- String representing the object's type. Objects of the same type share the same value.
- billed_
until float - The time period the subscription item has been billed for.
- created float
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current_
period_ floatend - The end time of this subscription item's current billing period.
- current_
period_ floatstart - The start time of this subscription item's current billing period.
- id str
- The provider-assigned unique ID for this managed resource.
- object str
- String representing the object's type. Objects of the same type share the same value.
- billed
Until Number - The time period the subscription item has been billed for.
- created Number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current
Period NumberEnd - The end time of this subscription item's current billing period.
- current
Period NumberStart - The start time of this subscription item's current billing period.
- id String
- The provider-assigned unique ID for this managed resource.
- object String
- String representing the object's type. Objects of the same type share the same value.
Look up Existing SubscriptionItem Resource
Get an existing SubscriptionItem 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?: SubscriptionItemState, opts?: CustomResourceOptions): SubscriptionItem@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
billed_until: Optional[float] = None,
billing_thresholds: Optional[SubscriptionItemBillingThresholdsArgs] = None,
created: Optional[float] = None,
current_period_end: Optional[float] = None,
current_period_start: Optional[float] = None,
discounts: Optional[Sequence[SubscriptionItemDiscountArgs]] = None,
metadata: Optional[Mapping[str, str]] = None,
object: Optional[str] = None,
payment_behavior: Optional[str] = None,
plan: Optional[str] = None,
price: Optional[str] = None,
price_data: Optional[SubscriptionItemPriceDataArgs] = None,
proration_behavior: Optional[str] = None,
proration_date: Optional[float] = None,
quantity: Optional[float] = None,
subscription: Optional[str] = None,
tax_rates: Optional[Sequence[str]] = None) -> SubscriptionItemfunc GetSubscriptionItem(ctx *Context, name string, id IDInput, state *SubscriptionItemState, opts ...ResourceOption) (*SubscriptionItem, error)public static SubscriptionItem Get(string name, Input<string> id, SubscriptionItemState? state, CustomResourceOptions? opts = null)public static SubscriptionItem get(String name, Output<String> id, SubscriptionItemState state, CustomResourceOptions options)resources: _: type: stripe:SubscriptionItem get: id: ${id}import {
to = stripe_subscription_item.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.
- Billed
Until double - The time period the subscription item has been billed for.
- Billing
Thresholds SubscriptionItem Billing Thresholds - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- Created double
- Time at which the object was created. Measured in seconds since the Unix epoch.
- Current
Period doubleEnd - The end time of this subscription item's current billing period.
- Current
Period doubleStart - The start time of this subscription item's current billing period.
- Discounts
List<Subscription
Item Discount> - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - Metadata Dictionary<string, string>
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- Object string
- String representing the object's type. Objects of the same type share the same value.
- Payment
Behavior string - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - Plan string
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- Price string
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.
- Price
Data SubscriptionItem Price Data - Data used to generate a new Price object inline.
- Proration
Behavior string - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - Proration
Date double - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- Quantity double
- The quantity of the plan to which the customer should be subscribed.
- Subscription string
- The
subscriptionthissubscription_itembelongs to. - Tax
Rates List<string> - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- Billed
Until float64 - The time period the subscription item has been billed for.
- Billing
Thresholds SubscriptionItem Billing Thresholds Args - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- Created float64
- Time at which the object was created. Measured in seconds since the Unix epoch.
- Current
Period float64End - The end time of this subscription item's current billing period.
- Current
Period float64Start - The start time of this subscription item's current billing period.
- Discounts
[]Subscription
Item Discount Args - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - Metadata map[string]string
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- Object string
- String representing the object's type. Objects of the same type share the same value.
- Payment
Behavior string - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - Plan string
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- Price string
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.
- Price
Data SubscriptionItem Price Data Args - Data used to generate a new Price object inline.
- Proration
Behavior string - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - Proration
Date float64 - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- Quantity float64
- The quantity of the plan to which the customer should be subscribed.
- Subscription string
- The
subscriptionthissubscription_itembelongs to. - Tax
Rates []string - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- billed_
until number - The time period the subscription item has been billed for.
- billing_
thresholds object - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- created number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current_
period_ numberend - The end time of this subscription item's current billing period.
- current_
period_ numberstart - The start time of this subscription item's current billing period.
- discounts list(object)
- The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - metadata map(string)
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- object string
- String representing the object's type. Objects of the same type share the same value.
- payment_
behavior string - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan string
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price string
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.
- price_
data object - Data used to generate a new Price object inline.
- proration_
behavior string - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration_
date number - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity number
- The quantity of the plan to which the customer should be subscribed.
- subscription string
- The
subscriptionthissubscription_itembelongs to. - tax_
rates list(string) - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- billed
Until Double - The time period the subscription item has been billed for.
- billing
Thresholds SubscriptionItem Billing Thresholds - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- created Double
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current
Period DoubleEnd - The end time of this subscription item's current billing period.
- current
Period DoubleStart - The start time of this subscription item's current billing period.
- discounts
List<Subscription
Item Discount> - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - metadata Map<String,String>
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- object String
- String representing the object's type. Objects of the same type share the same value.
- payment
Behavior String - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan String
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price String
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.
- price
Data SubscriptionItem Price Data - Data used to generate a new Price object inline.
- proration
Behavior String - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration
Date Double - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity Double
- The quantity of the plan to which the customer should be subscribed.
- subscription String
- The
subscriptionthissubscription_itembelongs to. - tax
Rates List<String> - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- billed
Until number - The time period the subscription item has been billed for.
- billing
Thresholds SubscriptionItem Billing Thresholds - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- created number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current
Period numberEnd - The end time of this subscription item's current billing period.
- current
Period numberStart - The start time of this subscription item's current billing period.
- discounts
Subscription
Item Discount[] - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - metadata {[key: string]: string}
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- object string
- String representing the object's type. Objects of the same type share the same value.
- payment
Behavior string - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan string
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price string
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.
- price
Data SubscriptionItem Price Data - Data used to generate a new Price object inline.
- proration
Behavior string - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration
Date number - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity number
- The quantity of the plan to which the customer should be subscribed.
- subscription string
- The
subscriptionthissubscription_itembelongs to. - tax
Rates string[] - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- billed_
until float - The time period the subscription item has been billed for.
- billing_
thresholds SubscriptionItem Billing Thresholds Args - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- created float
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current_
period_ floatend - The end time of this subscription item's current billing period.
- current_
period_ floatstart - The start time of this subscription item's current billing period.
- discounts
Sequence[Subscription
Item Discount Args] - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - metadata Mapping[str, str]
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- object str
- String representing the object's type. Objects of the same type share the same value.
- payment_
behavior str - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan str
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price str
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.
- price_
data SubscriptionItem Price Data Args - Data used to generate a new Price object inline.
- proration_
behavior str - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration_
date float - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity float
- The quantity of the plan to which the customer should be subscribed.
- subscription str
- The
subscriptionthissubscription_itembelongs to. - tax_
rates Sequence[str] - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
- billed
Until Number - The time period the subscription item has been billed for.
- billing
Thresholds Property Map - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
- created Number
- Time at which the object was created. Measured in seconds since the Unix epoch.
- current
Period NumberEnd - The end time of this subscription item's current billing period.
- current
Period NumberStart - The start time of this subscription item's current billing period.
- discounts List<Property Map>
- The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use
expand[]=discountsto expand each discount. - metadata Map<String>
- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- object String
- String representing the object's type. Objects of the same type share the same value.
- payment
Behavior String - Controls how Stripe handles payment when a subscription update requires payment and
collection_method=charge_automatically. - plan String
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
- price String
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.
- price
Data Property Map - Data used to generate a new Price object inline.
- proration
Behavior String - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. - proration
Date Number - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.
- quantity Number
- The quantity of the plan to which the customer should be subscribed.
- subscription String
- The
subscriptionthissubscription_itembelongs to. - tax
Rates List<String> - The tax rates which apply to this
subscription_item. When set, thedefault_tax_rateson the subscription do not apply to thissubscription_item.
Supporting Types
SubscriptionItemBillingThresholds, SubscriptionItemBillingThresholdsArgs
- Usage
Gte double - Usage threshold that triggers the subscription to create an invoice
- Usage
Gte float64 - Usage threshold that triggers the subscription to create an invoice
- usage_
gte number - Usage threshold that triggers the subscription to create an invoice
- usage
Gte Double - Usage threshold that triggers the subscription to create an invoice
- usage
Gte number - Usage threshold that triggers the subscription to create an invoice
- usage_
gte float - Usage threshold that triggers the subscription to create an invoice
- usage
Gte Number - Usage threshold that triggers the subscription to create an invoice
SubscriptionItemDiscount, SubscriptionItemDiscountArgs
- Coupon string
- ID of the coupon to create a new discount for.
- Discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- Promotion
Code string - ID of the promotion code to create a new discount for.
- Coupon string
- ID of the coupon to create a new discount for.
- Discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- Promotion
Code string - ID of the promotion code to create a new discount for.
- coupon string
- ID of the coupon to create a new discount for.
- discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion_
code string - ID of the promotion code to create a new discount for.
- coupon String
- ID of the coupon to create a new discount for.
- discount String
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code String - ID of the promotion code to create a new discount for.
- coupon string
- ID of the coupon to create a new discount for.
- discount string
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code string - ID of the promotion code to create a new discount for.
- coupon str
- ID of the coupon to create a new discount for.
- discount str
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion_
code str - ID of the promotion code to create a new discount for.
- coupon String
- ID of the coupon to create a new discount for.
- discount String
- ID of an existing discount on the object (or one of its ancestors) to reuse.
- promotion
Code String - ID of the promotion code to create a new discount for.
SubscriptionItemPriceData, SubscriptionItemPriceDataArgs
- Currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- Product string
- The ID of the Product that this Price will belong to.
- Recurring
Subscription
Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - Tax
Behavior string - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - Unit
Amount double - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- Unit
Amount doubleDecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- Currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- Product string
- The ID of the Product that this Price will belong to.
- Recurring
Subscription
Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - Tax
Behavior string - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - Unit
Amount float64 - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- Unit
Amount float64Decimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product string
- The ID of the Product that this Price will belong to.
- recurring object
- The recurring components of a price such as
intervalandinterval_count. - tax_
behavior string - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit_
amount number - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit_
amount_ numberdecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency String
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product String
- The ID of the Product that this Price will belong to.
- recurring
Subscription
Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - tax
Behavior String - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit
Amount Double - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit
Amount DoubleDecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency string
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product string
- The ID of the Product that this Price will belong to.
- recurring
Subscription
Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - tax
Behavior string - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit
Amount number - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit
Amount numberDecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency str
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product str
- The ID of the Product that this Price will belong to.
- recurring
Subscription
Item Price Data Recurring - The recurring components of a price such as
intervalandinterval_count. - tax_
behavior str - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit_
amount float - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit_
amount_ floatdecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
- currency String
- Three-letter ISO currency code, in lowercase. Must be a supported currency.
- product String
- The ID of the Product that this Price will belong to.
- recurring Property Map
- The recurring components of a price such as
intervalandinterval_count. - tax
Behavior String - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. - unit
Amount Number - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
- unit
Amount NumberDecimal - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
SubscriptionItemPriceDataRecurring, SubscriptionItemPriceDataRecurringArgs
- Interval string
- Specifies billing frequency. Either
day,week,monthoryear. - Interval
Count double - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- Interval string
- Specifies billing frequency. Either
day,week,monthoryear. - Interval
Count float64 - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval string
- Specifies billing frequency. Either
day,week,monthoryear. - interval_
count number - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval String
- Specifies billing frequency. Either
day,week,monthoryear. - interval
Count Double - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval string
- Specifies billing frequency. Either
day,week,monthoryear. - interval
Count number - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval str
- Specifies billing frequency. Either
day,week,monthoryear. - interval_
count float - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
- interval String
- Specifies billing frequency. Either
day,week,monthoryear. - interval
Count Number - The number of intervals between subscription billings. For example,
interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
Package Details
- Repository
- stripe stripe/terraform-provider-stripe
- License
- Notes
- This Pulumi package is based on the
stripeTerraform Provider.
published on Friday, Aug 14, 2026 by Pulumi