Create an invoice item 

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

Parameters

• customerstringRequired

  The ID of the customer who will be billed when this invoice item is billed.

• amountinteger

  The integer amount in cents of the charge to be applied to the upcoming invoice. Passing in a negative amount will reduce the amount_due on the invoice.

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• descriptionstring

  An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

• periodobject

  The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

  Hide child parameters

  • period.endtimestampRequired

    The end of the period, which must be greater than or equal to the start. This value is inclusive.

  • period.starttimestampRequired

    The start of the period. This value is inclusive.

• pricingobject

  The pricing information for the invoice item.

  Hide child parameters

  • pricing.pricestring

    The ID of the price object.

More parameters

Collapse all

• discountableboolean

  Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.

• discountsarray of objects

  The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item.

  Hide child parameters

  • discounts.couponstring

    ID of the coupon to create a new discount for.

  • discounts.discountstring

    ID of an existing discount on the object (or one of its ancestors) to reuse.

  • discounts.promotion_codestring

    ID of the promotion code to create a new discount for.

• invoicestring

  The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won’t be automatically added unless you pass pending_invoice_item_behavior: 'include' when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.

• price_dataobject

  Data used to generate a new Price object inline.

  Hide child parameters

  • price_data.currencyenumRequired

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • price_data.productstringRequired

    The ID of the Product that this Price will belong to.

  • price_data.tax_behaviorenumRecommended if calculating taxes

    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.

    Possible enum values

    exclusive

    inclusive

    unspecified

  • price_data.unit_amountinteger

    A positive integer in cents (or 0 for a free price) representing how much to charge.

  • price_data.unit_amount_decimalstringRequired conditionally

    Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

• quantityinteger

  Non-negative integer. The quantity of units for the invoice item.

• subscriptionstring

  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_behaviorenumRecommended if calculating taxes

  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.

  Possible enum values

  exclusive

  inclusive

  unspecified

• tax_codestringRecommended if calculating taxes

  A tax code ID.

• tax_ratesarray of strings

  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_decimalstring

  The decimal unit amount in cents 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.