Update an invoice's line item

Changed on

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.

post/v1/invoices/{invoice}/lines/{line_item_id}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/invoices/{invoice}/lines/{line_item_id}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

invoicestring required

Invoice ID of line item

line_item_idstring required

Invoice line item ID

Request body application/x-www-form-urlencoded

amountinteger

The integer amount in cents (or local equivalent) 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.

discountableboolean

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

expandstring[]

Specifies which fields in the response should be expanded.

quantityinteger

Non-negative integer. The quantity of units for the line item. Use quantity_decimal instead to provide decimal precision. This field will be deprecated in favor of quantity_decimal in a future version.

quantity_decimalstring decimal

Non-negative decimal with at most 12 decimal places. The quantity of units for the line item.

Response

Successful response.

amountinteger required

The amount, in cents (or local equivalent).

currencystring currency required

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

descriptionstring nullable

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

discountableboolean required

If true, discounts will apply to this line item. Always false for prorations.

idstring required

Unique identifier for the object.

invoicestring nullable

The ID of the invoice that contains this line item.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'line_item' required

String representing the object's type. Objects of the same type share the same value.

quantityinteger nullable

Quantity of units for the invoice line item in integer format, with any decimal precision truncated. For the line 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 line item is a proration or subscription, the quantity of the subscription that the proration was computed for.

quantity_decimalstring decimal nullable

Non-negative decimal with at most 12 decimal places. The quantity of units for the line item.

subtotalinteger required

The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes.

Changes

  • 743273d7a7b7Revision changes
    • info

      added the required property to the response with the status

  • b22313c11340Revision changes
    • breaking

      the /// response property's maxLength was unset from 5000 for the response status

    • breaking

      the /// response's property type changed from string to no type for status

    This list may be incomplete.

Some revisions have not been checked yet.