Attributes

• idstring

  Unique identifier for the object.

• amountinteger

  The amount, in cents.

• currencyenum

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

• descriptionnullable string

  An arbitrary string attached to the object. Often useful for displaying to users.

• invoicenullable string

  The ID of the invoice that contains this line item.

• 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. Note that for line items with type=subscription, metadata reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.

• periodobject

  The period this line_item covers. For subscription line items, this is the subscription period. For prorations, this starts when the proration was calculated, and ends at the period end of the subscription. For invoice items, this is the time at which the invoice item was created or the period of the item. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

  Show child attributes

• pricenullable object

  The price of the line item.

  Show child attributes

• prorationboolean

  Whether this is a proration.

• quantitynullable integer

  The quantity of the subscription, if the line item is a subscription or a proration.

• typeenum

  A string identifying the type of the source of this line item, either an invoiceitem or a subscription.

  Possible enum values

  invoiceitem

  subscription

More attributes

Expand all

• objectstring

• amount_excluding_taxnullable integer

• discount_amountsnullable array of objects

• discountableboolean

• discountsarray of stringsExpandable

• invoice_itemnullable stringExpandable

• livemodeboolean

• pretax_credit_amountsnullable array of objectsPreview feature

• proration_detailsnullable object

• subscriptionnullable stringExpandable

• subscription_itemnullable stringExpandable

• tax_amountsarray of objects

• tax_ratesarray of objects

• unit_amount_excluding_taxnullable decimal string

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item, so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. Updating an invoice’s line item is only possible before the invoice is finalized.

Parameters

• invoicestringRequired

  Invoice ID of line item

• line_item_idstringRequired

  Invoice line item ID

• amountinteger

  The integer amount in cents of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer’s account, pass a negative amount.

• 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. For type=subscription line items, the incoming metadata specified on the request is directly used to set this value, in contrast to type=invoiceitem line items, where any existing metadata on the invoice line is merged with the incoming data.

• 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.

  Show child parameters

• pricestring

  The ID of the price object. One of price or price_data is required.

• quantityinteger

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

More parameters

Expand all

• discountableboolean

• discountsarray of objects

• price_dataobject

• tax_amountsarray of objects

• tax_ratesarray of strings

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Parameters

No parameters.

More parameters

Expand all

• ending_beforestring

• limitinteger

• starting_afterstring

When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Parameters

• customerstring

  The identifier of the customer whose upcoming invoice you’d like to retrieve. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set.

• subscriptionstring

  The identifier of the subscription for which you’d like to retrieve the upcoming invoice. If not provided, but a subscription_details.items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_details.items is provided, you will retrieve the next upcoming invoice from among the customer’s subscriptions.

More parameters

Expand all

• automatic_taxobject

• couponstringDeprecated

• currencyenum

• customer_detailsobject

• discountsarray of objects

• ending_beforestring

• invoice_itemsarray of objects

• issuerobjectConnect only

• limitinteger

• on_behalf_ofstringConnect only

• preview_modeenum

• schedulestring

• schedule_detailsobject

• starting_afterstring

• subscription_billing_cycle_anchorstring | timestampDeprecated

• subscription_cancel_attimestampDeprecated

• subscription_cancel_at_period_endbooleanDeprecated

• subscription_cancel_nowbooleanDeprecated

• subscription_default_tax_ratesarray of stringsDeprecated

• subscription_detailsobject

• subscription_itemsarray of objectsDeprecated

• subscription_proration_behaviorenumDeprecated

• subscription_proration_datetimestampDeprecated

• subscription_resume_atstringDeprecated

• subscription_start_datetimestampDeprecated

• subscription_trial_endstring | timestampDeprecated