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

stripe.InvoiceItem

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

    Invoice Items represent the component lines of an invoice. When you create an invoice item with an invoice field, it is attached to the specified invoice and included as an invoice line item within invoice.lines.

    Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a subscription. Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.

    Related guides: Integrate with the Invoicing API, Subscription Invoices.

    Create InvoiceItem Resource

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

    Constructor syntax

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

@overload
def InvoiceItem(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                amount: Optional[float] = None,
                currency: Optional[str] = None,
                customer: Optional[str] = None,
                description: Optional[str] = None,
                discountable: Optional[bool] = None,
                discounts: Optional[Sequence[InvoiceItemDiscountArgs]] = None,
                invoice: Optional[str] = None,
                metadata: Optional[Mapping[str, str]] = None,
                period: Optional[InvoiceItemPeriodArgs] = None,
                price_data: Optional[InvoiceItemPriceDataArgs] = None,
                pricing: Optional[InvoiceItemPricingArgs] = None,
                quantity: Optional[float] = None,
                quantity_decimal: Optional[float] = None,
                subscription: Optional[str] = None,
                tax_behavior: Optional[str] = None,
                tax_code: Optional[str] = None,
                tax_rates: Optional[Sequence[str]] = None,
                unit_amount_decimal: Optional[float] = None)
    func NewInvoiceItem(ctx *Context, name string, args *InvoiceItemArgs, opts ...ResourceOption) (*InvoiceItem, error)
    public InvoiceItem(string name, InvoiceItemArgs? args = null, CustomResourceOptions? opts = null)
    public InvoiceItem(String name, InvoiceItemArgs args)
public InvoiceItem(String name, InvoiceItemArgs args, CustomResourceOptions options)

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


    resource "stripe_invoice_item" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args InvoiceItemArgs
    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 InvoiceItemArgs
    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 InvoiceItemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InvoiceItemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InvoiceItemArgs
    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 invoiceItemResource = new Stripe.InvoiceItem("invoiceItemResource", new()
{
    Amount = 0.0,
    Currency = "string",
    Customer = "string",
    Description = "string",
    Discountable = false,
    Discounts = new[]
    {
        new Stripe.Inputs.InvoiceItemDiscountArgs
        {
            Coupon = "string",
            Discount = "string",
            PromotionCode = "string",
        },
    },
    Invoice = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Period = new Stripe.Inputs.InvoiceItemPeriodArgs
    {
        End = 0.0,
        Start = 0.0,
    },
    PriceData = new Stripe.Inputs.InvoiceItemPriceDataArgs
    {
        Currency = "string",
        Product = "string",
        TaxBehavior = "string",
        UnitAmount = 0.0,
        UnitAmountDecimal = 0.0,
    },
    Pricing = new Stripe.Inputs.InvoiceItemPricingArgs
    {
        Price = "string",
        PriceDetails = new Stripe.Inputs.InvoiceItemPricingPriceDetailsArgs
        {
            Price = "string",
            Product = "string",
        },
        Type = "string",
        UnitAmountDecimal = 0.0,
    },
    Quantity = 0.0,
    QuantityDecimal = 0.0,
    Subscription = "string",
    TaxBehavior = "string",
    TaxCode = "string",
    TaxRates = new[]
    {
        "string",
    },
    UnitAmountDecimal = 0.0,
});

    example, err := stripe.NewInvoiceItem(ctx, "invoiceItemResource", &stripe.InvoiceItemArgs{
	Amount:       pulumi.Float64(0),
	Currency:     pulumi.String("string"),
	Customer:     pulumi.String("string"),
	Description:  pulumi.String("string"),
	Discountable: pulumi.Bool(false),
	Discounts: stripe.InvoiceItemDiscountArray{
		&stripe.InvoiceItemDiscountArgs{
			Coupon:        pulumi.String("string"),
			Discount:      pulumi.String("string"),
			PromotionCode: pulumi.String("string"),
		},
	},
	Invoice: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Period: &stripe.InvoiceItemPeriodArgs{
		End:   pulumi.Float64(0),
		Start: pulumi.Float64(0),
	},
	PriceData: &stripe.InvoiceItemPriceDataArgs{
		Currency:          pulumi.String("string"),
		Product:           pulumi.String("string"),
		TaxBehavior:       pulumi.String("string"),
		UnitAmount:        pulumi.Float64(0),
		UnitAmountDecimal: pulumi.Float64(0),
	},
	Pricing: &stripe.InvoiceItemPricingArgs{
		Price: pulumi.String("string"),
		PriceDetails: &stripe.InvoiceItemPricingPriceDetailsArgs{
			Price:   pulumi.String("string"),
			Product: pulumi.String("string"),
		},
		Type:              pulumi.String("string"),
		UnitAmountDecimal: pulumi.Float64(0),
	},
	Quantity:        pulumi.Float64(0),
	QuantityDecimal: pulumi.Float64(0),
	Subscription:    pulumi.String("string"),
	TaxBehavior:     pulumi.String("string"),
	TaxCode:         pulumi.String("string"),
	TaxRates: pulumi.StringArray{
		pulumi.String("string"),
	},
	UnitAmountDecimal: pulumi.Float64(0),
})

    resource "stripe_invoice_item" "invoiceItemResource" {
  lifecycle {
    create_before_destroy = true
  }
  amount       = 0
  currency     = "string"
  customer     = "string"
  description  = "string"
  discountable = false
  discounts {
    coupon         = "string"
    discount       = "string"
    promotion_code = "string"
  }
  invoice = "string"
  metadata = {
    "string" = "string"
  }
  period = {
    end   = 0
    start = 0
  }
  price_data = {
    currency            = "string"
    product             = "string"
    tax_behavior        = "string"
    unit_amount         = 0
    unit_amount_decimal = 0
  }
  pricing = {
    price = "string"
    price_details = {
      price   = "string"
      product = "string"
    }
    type                = "string"
    unit_amount_decimal = 0
  }
  quantity            = 0
  quantity_decimal    = 0
  subscription        = "string"
  tax_behavior        = "string"
  tax_code            = "string"
  tax_rates           = ["string"]
  unit_amount_decimal = 0
}

    var invoiceItemResource = new InvoiceItem("invoiceItemResource", InvoiceItemArgs.builder()
    .amount(0.0)
    .currency("string")
    .customer("string")
    .description("string")
    .discountable(false)
    .discounts(InvoiceItemDiscountArgs.builder()
        .coupon("string")
        .discount("string")
        .promotionCode("string")
        .build())
    .invoice("string")
    .metadata(Map.of("string", "string"))
    .period(InvoiceItemPeriodArgs.builder()
        .end(0.0)
        .start(0.0)
        .build())
    .priceData(InvoiceItemPriceDataArgs.builder()
        .currency("string")
        .product("string")
        .taxBehavior("string")
        .unitAmount(0.0)
        .unitAmountDecimal(0.0)
        .build())
    .pricing(InvoiceItemPricingArgs.builder()
        .price("string")
        .priceDetails(InvoiceItemPricingPriceDetailsArgs.builder()
            .price("string")
            .product("string")
            .build())
        .type("string")
        .unitAmountDecimal(0.0)
        .build())
    .quantity(0.0)
    .quantityDecimal(0.0)
    .subscription("string")
    .taxBehavior("string")
    .taxCode("string")
    .taxRates("string")
    .unitAmountDecimal(0.0)
    .build());

    invoice_item_resource = stripe.InvoiceItem("invoiceItemResource",
    amount=float(0),
    currency="string",
    customer="string",
    description="string",
    discountable=False,
    discounts=[{
        "coupon": "string",
        "discount": "string",
        "promotion_code": "string",
    }],
    invoice="string",
    metadata={
        "string": "string",
    },
    period={
        "end": float(0),
        "start": float(0),
    },
    price_data={
        "currency": "string",
        "product": "string",
        "tax_behavior": "string",
        "unit_amount": float(0),
        "unit_amount_decimal": float(0),
    },
    pricing={
        "price": "string",
        "price_details": {
            "price": "string",
            "product": "string",
        },
        "type": "string",
        "unit_amount_decimal": float(0),
    },
    quantity=float(0),
    quantity_decimal=float(0),
    subscription="string",
    tax_behavior="string",
    tax_code="string",
    tax_rates=["string"],
    unit_amount_decimal=float(0))

    const invoiceItemResource = new stripe.InvoiceItem("invoiceItemResource", {
    amount: 0,
    currency: "string",
    customer: "string",
    description: "string",
    discountable: false,
    discounts: [{
        coupon: "string",
        discount: "string",
        promotionCode: "string",
    }],
    invoice: "string",
    metadata: {
        string: "string",
    },
    period: {
        end: 0,
        start: 0,
    },
    priceData: {
        currency: "string",
        product: "string",
        taxBehavior: "string",
        unitAmount: 0,
        unitAmountDecimal: 0,
    },
    pricing: {
        price: "string",
        priceDetails: {
            price: "string",
            product: "string",
        },
        type: "string",
        unitAmountDecimal: 0,
    },
    quantity: 0,
    quantityDecimal: 0,
    subscription: "string",
    taxBehavior: "string",
    taxCode: "string",
    taxRates: ["string"],
    unitAmountDecimal: 0,
});

    type: stripe:InvoiceItem
properties:
    amount: 0
    currency: string
    customer: string
    description: string
    discountable: false
    discounts:
        - coupon: string
          discount: string
          promotionCode: string
    invoice: string
    metadata:
        string: string
    period:
        end: 0
        start: 0
    priceData:
        currency: string
        product: string
        taxBehavior: string
        unitAmount: 0
        unitAmountDecimal: 0
    pricing:
        price: string
        priceDetails:
            price: string
            product: string
        type: string
        unitAmountDecimal: 0
    quantity: 0
    quantityDecimal: 0
    subscription: string
    taxBehavior: string
    taxCode: string
    taxRates:
        - string
    unitAmountDecimal: 0

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

    Amount double
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    The ID of the customer to bill for this invoice item.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Discountable bool
    If true, discounts will apply to this invoice item. Always false for prorations.
    Discounts List<InvoiceItemDiscount>
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    Invoice string
    The ID of the invoice this invoice item belongs to.
    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.
    Period InvoiceItemPeriod
    PriceData InvoiceItemPriceData
    Data used to generate a new Price object inline.
    Pricing InvoiceItemPricing
    The pricing information of the invoice item.
    Quantity double
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    QuantityDecimal double
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    Subscription string
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    TaxCode string
    A tax code ID.
    TaxRates List<string>
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    UnitAmountDecimal double
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    Amount float64
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    The ID of the customer to bill for this invoice item.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Discountable bool
    If true, discounts will apply to this invoice item. Always false for prorations.
    Discounts []InvoiceItemDiscountArgs
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    Invoice string
    The ID of the invoice this invoice item belongs to.
    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.
    Period InvoiceItemPeriodArgs
    PriceData InvoiceItemPriceDataArgs
    Data used to generate a new Price object inline.
    Pricing InvoiceItemPricingArgs
    The pricing information of the invoice item.
    Quantity float64
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    QuantityDecimal float64
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    Subscription string
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    TaxCode string
    A tax code ID.
    TaxRates []string
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    UnitAmountDecimal float64
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount number
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    The ID of the customer to bill for this invoice item.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable bool
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts list(object)
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice string
    The ID of the invoice this invoice item belongs to.
    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.
    period object
    price_data object
    Data used to generate a new Price object inline.
    pricing object
    The pricing information of the invoice item.
    quantity number
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantity_decimal number
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription string
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    tax_code string
    A tax code ID.
    tax_rates list(string)
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    unit_amount_decimal number
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount Double
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    The ID of the customer to bill for this invoice item.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable Boolean
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts List<InvoiceItemDiscount>
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice String
    The ID of the invoice this invoice item belongs to.
    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.
    period InvoiceItemPeriod
    priceData InvoiceItemPriceData
    Data used to generate a new Price object inline.
    pricing InvoiceItemPricing
    The pricing information of the invoice item.
    quantity Double
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantityDecimal Double
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription String
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    taxCode String
    A tax code ID.
    taxRates List<String>
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    unitAmountDecimal Double
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount number
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    The ID of the customer to bill for this invoice item.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable boolean
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts InvoiceItemDiscount[]
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice string
    The ID of the invoice this invoice item belongs to.
    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.
    period InvoiceItemPeriod
    priceData InvoiceItemPriceData
    Data used to generate a new Price object inline.
    pricing InvoiceItemPricing
    The pricing information of the invoice item.
    quantity number
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantityDecimal number
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription string
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    taxCode string
    A tax code ID.
    taxRates string[]
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    unitAmountDecimal number
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount float
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer str
    The ID of the customer to bill for this invoice item.
    description str
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable bool
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts Sequence[InvoiceItemDiscountArgs]
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice str
    The ID of the invoice this invoice item belongs to.
    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.
    period InvoiceItemPeriodArgs
    price_data InvoiceItemPriceDataArgs
    Data used to generate a new Price object inline.
    pricing InvoiceItemPricingArgs
    The pricing information of the invoice item.
    quantity float
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantity_decimal float
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription str
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    tax_code str
    A tax code ID.
    tax_rates Sequence[str]
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    unit_amount_decimal float
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount Number
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    The ID of the customer to bill for this invoice item.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable Boolean
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts List<Property Map>
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice String
    The ID of the invoice this invoice item belongs to.
    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.
    period Property Map
    priceData Property Map
    Data used to generate a new Price object inline.
    pricing Property Map
    The pricing information of the invoice item.
    quantity Number
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantityDecimal Number
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription String
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    taxCode String
    A tax code ID.
    taxRates List<String>
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    unitAmountDecimal Number
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.

    Outputs

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

    Date 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.
    Parent InvoiceItemParent
    The parent that generated this invoice item.
    Proration bool
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    ProrationDetails InvoiceItemProrationDetails
    TestClock string
    ID of the test clock this invoice item belongs to.
    Date 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.
    Parent InvoiceItemParent
    The parent that generated this invoice item.
    Proration bool
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    ProrationDetails InvoiceItemProrationDetails
    TestClock string
    ID of the test clock this invoice item belongs to.
    date 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.
    parent object
    The parent that generated this invoice item.
    proration bool
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    proration_details object
    test_clock string
    ID of the test clock this invoice item belongs to.
    date 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.
    parent InvoiceItemParent
    The parent that generated this invoice item.
    proration Boolean
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    prorationDetails InvoiceItemProrationDetails
    testClock String
    ID of the test clock this invoice item belongs to.
    date 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.
    parent InvoiceItemParent
    The parent that generated this invoice item.
    proration boolean
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    prorationDetails InvoiceItemProrationDetails
    testClock string
    ID of the test clock this invoice item belongs to.
    date 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.
    parent InvoiceItemParent
    The parent that generated this invoice item.
    proration bool
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    proration_details InvoiceItemProrationDetails
    test_clock str
    ID of the test clock this invoice item belongs to.
    date 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.
    parent Property Map
    The parent that generated this invoice item.
    proration Boolean
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    prorationDetails Property Map
    testClock String
    ID of the test clock this invoice item belongs to.

    Look up Existing InvoiceItem Resource

    Get an existing InvoiceItem 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?: InvoiceItemState, opts?: CustomResourceOptions): InvoiceItem
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amount: Optional[float] = None,
        currency: Optional[str] = None,
        customer: Optional[str] = None,
        date: Optional[float] = None,
        description: Optional[str] = None,
        discountable: Optional[bool] = None,
        discounts: Optional[Sequence[InvoiceItemDiscountArgs]] = None,
        invoice: Optional[str] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        object: Optional[str] = None,
        parent: Optional[InvoiceItemParentArgs] = None,
        period: Optional[InvoiceItemPeriodArgs] = None,
        price_data: Optional[InvoiceItemPriceDataArgs] = None,
        pricing: Optional[InvoiceItemPricingArgs] = None,
        proration: Optional[bool] = None,
        proration_details: Optional[InvoiceItemProrationDetailsArgs] = None,
        quantity: Optional[float] = None,
        quantity_decimal: Optional[float] = None,
        subscription: Optional[str] = None,
        tax_behavior: Optional[str] = None,
        tax_code: Optional[str] = None,
        tax_rates: Optional[Sequence[str]] = None,
        test_clock: Optional[str] = None,
        unit_amount_decimal: Optional[float] = None) -> InvoiceItem
    func GetInvoiceItem(ctx *Context, name string, id IDInput, state *InvoiceItemState, opts ...ResourceOption) (*InvoiceItem, error)
    public static InvoiceItem Get(string name, Input<string> id, InvoiceItemState? state, CustomResourceOptions? opts = null)
    public static InvoiceItem get(String name, Output<String> id, InvoiceItemState state, CustomResourceOptions options)
    resources:  _:    type: stripe:InvoiceItem    get:      id: ${id}
    import {
  to = stripe_invoice_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.
    The following state arguments are supported:
    Amount double
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    The ID of the customer to bill for this invoice item.
    Date double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Discountable bool
    If true, discounts will apply to this invoice item. Always false for prorations.
    Discounts List<InvoiceItemDiscount>
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    Invoice string
    The ID of the invoice this invoice item belongs to.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Parent InvoiceItemParent
    The parent that generated this invoice item.
    Period InvoiceItemPeriod
    PriceData InvoiceItemPriceData
    Data used to generate a new Price object inline.
    Pricing InvoiceItemPricing
    The pricing information of the invoice item.
    Proration bool
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    ProrationDetails InvoiceItemProrationDetails
    Quantity double
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    QuantityDecimal double
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    Subscription string
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    TaxCode string
    A tax code ID.
    TaxRates List<string>
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    TestClock string
    ID of the test clock this invoice item belongs to.
    UnitAmountDecimal double
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    Amount float64
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Customer string
    The ID of the customer to bill for this invoice item.
    Date float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    Discountable bool
    If true, discounts will apply to this invoice item. Always false for prorations.
    Discounts []InvoiceItemDiscountArgs
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    Invoice string
    The ID of the invoice this invoice item belongs to.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Parent InvoiceItemParentArgs
    The parent that generated this invoice item.
    Period InvoiceItemPeriodArgs
    PriceData InvoiceItemPriceDataArgs
    Data used to generate a new Price object inline.
    Pricing InvoiceItemPricingArgs
    The pricing information of the invoice item.
    Proration bool
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    ProrationDetails InvoiceItemProrationDetailsArgs
    Quantity float64
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    QuantityDecimal float64
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    Subscription string
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    TaxCode string
    A tax code ID.
    TaxRates []string
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    TestClock string
    ID of the test clock this invoice item belongs to.
    UnitAmountDecimal float64
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount number
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    The ID of the customer to bill for this invoice item.
    date number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable bool
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts list(object)
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice string
    The ID of the invoice this invoice item belongs to.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object string
    String representing the object's type. Objects of the same type share the same value.
    parent object
    The parent that generated this invoice item.
    period object
    price_data object
    Data used to generate a new Price object inline.
    pricing object
    The pricing information of the invoice item.
    proration bool
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    proration_details object
    quantity number
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantity_decimal number
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription string
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    tax_code string
    A tax code ID.
    tax_rates list(string)
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    test_clock string
    ID of the test clock this invoice item belongs to.
    unit_amount_decimal number
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount Double
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    The ID of the customer to bill for this invoice item.
    date Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable Boolean
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts List<InvoiceItemDiscount>
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice String
    The ID of the invoice this invoice item belongs to.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object String
    String representing the object's type. Objects of the same type share the same value.
    parent InvoiceItemParent
    The parent that generated this invoice item.
    period InvoiceItemPeriod
    priceData InvoiceItemPriceData
    Data used to generate a new Price object inline.
    pricing InvoiceItemPricing
    The pricing information of the invoice item.
    proration Boolean
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    prorationDetails InvoiceItemProrationDetails
    quantity Double
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantityDecimal Double
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription String
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    taxCode String
    A tax code ID.
    taxRates List<String>
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    testClock String
    ID of the test clock this invoice item belongs to.
    unitAmountDecimal Double
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount number
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer string
    The ID of the customer to bill for this invoice item.
    date number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable boolean
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts InvoiceItemDiscount[]
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice string
    The ID of the invoice this invoice item belongs to.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object string
    String representing the object's type. Objects of the same type share the same value.
    parent InvoiceItemParent
    The parent that generated this invoice item.
    period InvoiceItemPeriod
    priceData InvoiceItemPriceData
    Data used to generate a new Price object inline.
    pricing InvoiceItemPricing
    The pricing information of the invoice item.
    proration boolean
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    prorationDetails InvoiceItemProrationDetails
    quantity number
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantityDecimal number
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription string
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    taxCode string
    A tax code ID.
    taxRates string[]
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    testClock string
    ID of the test clock this invoice item belongs to.
    unitAmountDecimal number
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount float
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer str
    The ID of the customer to bill for this invoice item.
    date float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    description str
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable bool
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts Sequence[InvoiceItemDiscountArgs]
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice str
    The ID of the invoice this invoice item belongs to.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object str
    String representing the object's type. Objects of the same type share the same value.
    parent InvoiceItemParentArgs
    The parent that generated this invoice item.
    period InvoiceItemPeriodArgs
    price_data InvoiceItemPriceDataArgs
    Data used to generate a new Price object inline.
    pricing InvoiceItemPricingArgs
    The pricing information of the invoice item.
    proration bool
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    proration_details InvoiceItemProrationDetailsArgs
    quantity float
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantity_decimal float
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription str
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    tax_code str
    A tax code ID.
    tax_rates Sequence[str]
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    test_clock str
    ID of the test clock this invoice item belongs to.
    unit_amount_decimal float
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.
    amount Number
    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customer String
    The ID of the customer to bill for this invoice item.
    date Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    discountable Boolean
    If true, discounts will apply to this invoice item. Always false for prorations.
    discounts List<Property Map>
    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    invoice String
    The ID of the invoice this invoice item belongs to.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    object String
    String representing the object's type. Objects of the same type share the same value.
    parent Property Map
    The parent that generated this invoice item.
    period Property Map
    priceData Property Map
    Data used to generate a new Price object inline.
    pricing Property Map
    The pricing information of the invoice item.
    proration Boolean
    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
    prorationDetails Property Map
    quantity Number
    Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use quantity_decimal. This field will be deprecated in favor of quantity_decimal in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
    quantityDecimal Number
    Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
    subscription String
    The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
    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.
    taxCode String
    A tax code ID.
    taxRates List<String>
    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
    testClock String
    ID of the test clock this invoice item belongs to.
    unitAmountDecimal Number
    The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount_decimal will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount_decimal will reduce the amount_due on the invoice. Accepts at most 12 decimal places.

    Supporting Types

    InvoiceItemDiscount, InvoiceItemDiscountArgs

    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.
    PromotionCode 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.
    PromotionCode 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.
    promotionCode 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.
    promotionCode 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.
    promotionCode String
    ID of the promotion code to create a new discount for.

    InvoiceItemParent, InvoiceItemParentArgs

    SubscriptionDetails InvoiceItemParentSubscriptionDetails
    Details about the subscription that generated this invoice item
    Type string
    The type of parent that generated this invoice item
    SubscriptionDetails InvoiceItemParentSubscriptionDetails
    Details about the subscription that generated this invoice item
    Type string
    The type of parent that generated this invoice item
    subscription_details object
    Details about the subscription that generated this invoice item
    type string
    The type of parent that generated this invoice item
    subscriptionDetails InvoiceItemParentSubscriptionDetails
    Details about the subscription that generated this invoice item
    type String
    The type of parent that generated this invoice item
    subscriptionDetails InvoiceItemParentSubscriptionDetails
    Details about the subscription that generated this invoice item
    type string
    The type of parent that generated this invoice item
    subscription_details InvoiceItemParentSubscriptionDetails
    Details about the subscription that generated this invoice item
    type str
    The type of parent that generated this invoice item
    subscriptionDetails Property Map
    Details about the subscription that generated this invoice item
    type String
    The type of parent that generated this invoice item

    InvoiceItemParentSubscriptionDetails, InvoiceItemParentSubscriptionDetailsArgs

    Subscription string
    The subscription that generated this invoice item
    SubscriptionItem string
    The subscription item that generated this invoice item
    Subscription string
    The subscription that generated this invoice item
    SubscriptionItem string
    The subscription item that generated this invoice item
    subscription string
    The subscription that generated this invoice item
    subscription_item string
    The subscription item that generated this invoice item
    subscription String
    The subscription that generated this invoice item
    subscriptionItem String
    The subscription item that generated this invoice item
    subscription string
    The subscription that generated this invoice item
    subscriptionItem string
    The subscription item that generated this invoice item
    subscription str
    The subscription that generated this invoice item
    subscription_item str
    The subscription item that generated this invoice item
    subscription String
    The subscription that generated this invoice item
    subscriptionItem String
    The subscription item that generated this invoice item

    InvoiceItemPeriod, InvoiceItemPeriodArgs

    End double
    The end of the period, which must be greater than or equal to the start. This value is inclusive.
    Start double
    The start of the period. This value is inclusive.
    End float64
    The end of the period, which must be greater than or equal to the start. This value is inclusive.
    Start float64
    The start of the period. This value is inclusive.
    end number
    The end of the period, which must be greater than or equal to the start. This value is inclusive.
    start number
    The start of the period. This value is inclusive.
    end Double
    The end of the period, which must be greater than or equal to the start. This value is inclusive.
    start Double
    The start of the period. This value is inclusive.
    end number
    The end of the period, which must be greater than or equal to the start. This value is inclusive.
    start number
    The start of the period. This value is inclusive.
    end float
    The end of the period, which must be greater than or equal to the start. This value is inclusive.
    start float
    The start of the period. This value is inclusive.
    end Number
    The end of the period, which must be greater than or equal to the start. This value is inclusive.
    start Number
    The start of the period. This value is inclusive.

    InvoiceItemPriceData, InvoiceItemPriceDataArgs

    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.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    UnitAmountDecimal double
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Product string
    The ID of the Product that this Price will belong to.
    TaxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    UnitAmount float64
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    UnitAmountDecimal float64
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product string
    The ID of the Product that this Price will belong to.
    tax_behavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unit_amount_decimal number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product String
    The ID of the Product that this Price will belong to.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Double
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal Double
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product string
    The ID of the Product that this Price will belong to.
    taxBehavior string
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product str
    The ID of the Product that this Price will belong to.
    tax_behavior str
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unit_amount float
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unit_amount_decimal float
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    product String
    The ID of the Product that this Price will belong to.
    taxBehavior String
    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.
    unitAmount Number
    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
    unitAmountDecimal Number
    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    InvoiceItemPricing, InvoiceItemPricingArgs

    Price string
    The ID of the price object.
    PriceDetails InvoiceItemPricingPriceDetails
    Type string
    The type of the pricing details.
    UnitAmountDecimal double
    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.
    Price string
    The ID of the price object.
    PriceDetails InvoiceItemPricingPriceDetails
    Type string
    The type of the pricing details.
    UnitAmountDecimal float64
    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.
    price string
    The ID of the price object.
    price_details object
    type string
    The type of the pricing details.
    unit_amount_decimal number
    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.
    price String
    The ID of the price object.
    priceDetails InvoiceItemPricingPriceDetails
    type String
    The type of the pricing details.
    unitAmountDecimal Double
    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.
    price string
    The ID of the price object.
    priceDetails InvoiceItemPricingPriceDetails
    type string
    The type of the pricing details.
    unitAmountDecimal number
    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.
    price str
    The ID of the price object.
    price_details InvoiceItemPricingPriceDetails
    type str
    The type of the pricing details.
    unit_amount_decimal float
    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.
    price String
    The ID of the price object.
    priceDetails Property Map
    type String
    The type of the pricing details.
    unitAmountDecimal Number
    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.

    InvoiceItemPricingPriceDetails, InvoiceItemPricingPriceDetailsArgs

    Price string
    The ID of the price this item is associated with.
    Product string
    The ID of the product this item is associated with.
    Price string
    The ID of the price this item is associated with.
    Product string
    The ID of the product this item is associated with.
    price string
    The ID of the price this item is associated with.
    product string
    The ID of the product this item is associated with.
    price String
    The ID of the price this item is associated with.
    product String
    The ID of the product this item is associated with.
    price string
    The ID of the price this item is associated with.
    product string
    The ID of the product this item is associated with.
    price str
    The ID of the price this item is associated with.
    product str
    The ID of the product this item is associated with.
    price String
    The ID of the price this item is associated with.
    product String
    The ID of the product this item is associated with.

    InvoiceItemProrationDetails, InvoiceItemProrationDetailsArgs

    CreditedItems InvoiceItemProrationDetailsCreditedItems
    For a credit proration, links to the debit invoice line items or invoice item that the credit applies to.
    DiscountAmounts List<InvoiceItemProrationDetailsDiscountAmount>
    Discount amounts applied when the proration was created.
    CreditedItems InvoiceItemProrationDetailsCreditedItems
    For a credit proration, links to the debit invoice line items or invoice item that the credit applies to.
    DiscountAmounts []InvoiceItemProrationDetailsDiscountAmount
    Discount amounts applied when the proration was created.
    credited_items object
    For a credit proration, links to the debit invoice line items or invoice item that the credit applies to.
    discount_amounts list(object)
    Discount amounts applied when the proration was created.
    creditedItems InvoiceItemProrationDetailsCreditedItems
    For a credit proration, links to the debit invoice line items or invoice item that the credit applies to.
    discountAmounts List<InvoiceItemProrationDetailsDiscountAmount>
    Discount amounts applied when the proration was created.
    creditedItems InvoiceItemProrationDetailsCreditedItems
    For a credit proration, links to the debit invoice line items or invoice item that the credit applies to.
    discountAmounts InvoiceItemProrationDetailsDiscountAmount[]
    Discount amounts applied when the proration was created.
    credited_items InvoiceItemProrationDetailsCreditedItems
    For a credit proration, links to the debit invoice line items or invoice item that the credit applies to.
    discount_amounts Sequence[InvoiceItemProrationDetailsDiscountAmount]
    Discount amounts applied when the proration was created.
    creditedItems Property Map
    For a credit proration, links to the debit invoice line items or invoice item that the credit applies to.
    discountAmounts List<Property Map>
    Discount amounts applied when the proration was created.

    InvoiceItemProrationDetailsCreditedItems, InvoiceItemProrationDetailsCreditedItemsArgs

    InvoiceItem string
    When type is invoice_item, the invoice item id for the debited invoice item corresponding to this credit proration.
    InvoiceLineItemDetails InvoiceItemProrationDetailsCreditedItemsInvoiceLineItemDetails
    Type string
    Whether the credit references a pending invoice item or one or more invoice line items on an invoice.
    InvoiceItem string
    When type is invoice_item, the invoice item id for the debited invoice item corresponding to this credit proration.
    InvoiceLineItemDetails InvoiceItemProrationDetailsCreditedItemsInvoiceLineItemDetails
    Type string
    Whether the credit references a pending invoice item or one or more invoice line items on an invoice.
    invoice_item string
    When type is invoice_item, the invoice item id for the debited invoice item corresponding to this credit proration.
    invoice_line_item_details object
    type string
    Whether the credit references a pending invoice item or one or more invoice line items on an invoice.
    invoiceItem String
    When type is invoice_item, the invoice item id for the debited invoice item corresponding to this credit proration.
    invoiceLineItemDetails InvoiceItemProrationDetailsCreditedItemsInvoiceLineItemDetails
    type String
    Whether the credit references a pending invoice item or one or more invoice line items on an invoice.
    invoiceItem string
    When type is invoice_item, the invoice item id for the debited invoice item corresponding to this credit proration.
    invoiceLineItemDetails InvoiceItemProrationDetailsCreditedItemsInvoiceLineItemDetails
    type string
    Whether the credit references a pending invoice item or one or more invoice line items on an invoice.
    invoice_item str
    When type is invoice_item, the invoice item id for the debited invoice item corresponding to this credit proration.
    invoice_line_item_details InvoiceItemProrationDetailsCreditedItemsInvoiceLineItemDetails
    type str
    Whether the credit references a pending invoice item or one or more invoice line items on an invoice.
    invoiceItem String
    When type is invoice_item, the invoice item id for the debited invoice item corresponding to this credit proration.
    invoiceLineItemDetails Property Map
    type String
    Whether the credit references a pending invoice item or one or more invoice line items on an invoice.

    InvoiceItemProrationDetailsCreditedItemsInvoiceLineItemDetails, InvoiceItemProrationDetailsCreditedItemsInvoiceLineItemDetailsArgs

    Invoice string
    The invoice id for the debited line item(s).
    InvoiceLineItems List<string>
    IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.
    Invoice string
    The invoice id for the debited line item(s).
    InvoiceLineItems []string
    IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.
    invoice string
    The invoice id for the debited line item(s).
    invoice_line_items list(string)
    IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.
    invoice String
    The invoice id for the debited line item(s).
    invoiceLineItems List<String>
    IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.
    invoice string
    The invoice id for the debited line item(s).
    invoiceLineItems string[]
    IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.
    invoice str
    The invoice id for the debited line item(s).
    invoice_line_items Sequence[str]
    IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.
    invoice String
    The invoice id for the debited line item(s).
    invoiceLineItems List<String>
    IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.

    InvoiceItemProrationDetailsDiscountAmount, InvoiceItemProrationDetailsDiscountAmountArgs

    Amount double
    The amount, in cents (or local equivalent), of the discount.
    Discount string
    The discount that was applied to get this discount amount.
    Amount float64
    The amount, in cents (or local equivalent), of the discount.
    Discount string
    The discount that was applied to get this discount amount.
    amount number
    The amount, in cents (or local equivalent), of the discount.
    discount string
    The discount that was applied to get this discount amount.
    amount Double
    The amount, in cents (or local equivalent), of the discount.
    discount String
    The discount that was applied to get this discount amount.
    amount number
    The amount, in cents (or local equivalent), of the discount.
    discount string
    The discount that was applied to get this discount amount.
    amount float
    The amount, in cents (or local equivalent), of the discount.
    discount str
    The discount that was applied to get this discount amount.
    amount Number
    The amount, in cents (or local equivalent), of the discount.
    discount String
    The discount that was applied to get this discount amount.

    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