Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.
Each line item is backed by either an invoice item or a subscription item.
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,metadatareflects 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_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.item - pricingnullable object
The pricing information of the line item.
- quantitynullable integer
The quantity of the subscription, if the line item is a subscription or a proration.
More attributes
- objectstring
- discount_
amountsnullable array of objects - discountableboolean
- discountsarray of stringsExpandable
- livemodeboolean
- parentnullable object
- pretax_
credit_ amountsnullable array of objects - taxesnullable array of objects
{ "id": "il_tmp_1Nzo1ZGgdF1VjufLzD1UUn9R", "object": "line_item", "amount": 1000, "currency": "usd", "description": "My First Invoice Item (created for API docs)", "discount_amounts": [], "discountable": true, "discounts": [], "livemode": false, "metadata": {}, "parent": { "type": "invoice_item_details", "invoice_item_details": { "invoice_item": "ii_1NpHiK2eZvKYlo2C9NdV8VrI", "proration": false, "proration_details": { "credited_items": null }, "subscription": null } }, "period": { "end": 1696975413, "start": 1696975413 }, "pricing": { "price_details": { "price": "price_1NzlYfGgdF1VjufL0cVjLJVI", "product": "prod_OnMHDH6VBmYlTr" }, "type": "price_details", "unit_amount_decimal": "1000" }, "quantity": 1, "tax_amounts": [], "tax_rates": [], "unit_amount_excluding_tax": "1000"}Updates an invoice’s line item. Some fields, such as tax_, 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.
- pricingobject
The pricing information for the invoice item.
- quantityinteger
Non-negative integer. The quantity of units for the line item.
More parameters
- discountableboolean
- discountsarray of objects
- price_
dataobject - tax_
amountsarray of objects - tax_
ratesarray of strings
Returns
The updated invoice’s line item object is returned upon success. Otherwise, this call raises an error.
{ "id": "il_tmp_1Nzo1ZGgdF1VjufLzD1UUn9R", "object": "line_item", "amount": 1000, "currency": "usd", "description": "My First Invoice Item (created for API docs)", "discount_amounts": [], "discountable": true, "discounts": [], "livemode": false, "metadata": {}, "parent": { "type": "invoice_item_details", "invoice_item_details": { "invoice_item": "ii_1Nzo1ZGgdF1VjufLzD1UUn9R", "proration": false, "proration_details": { "credited_items": null }, "subscription": null } }, "period": { "end": 1696975413, "start": 1696975413 }, "pricing": { "price_details": { "price": "price_1NzlYfGgdF1VjufL0cVjLJVI", "product": "prod_OnMHDH6VBmYlTr" }, "type": "price_details", "unit_amount_decimal": "1000" }, "quantity": 1, "taxes": []}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
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
Returns a list of line_item objects.
{ "object": "list", "url": "/v1/invoices/in_1NpHiG2eZvKYlo2CZV0ZkEBT/lines", "has_more": false, "data": [ { "id": "il_tmp_1NpHiK2eZvKYlo2C9NdV8VrI", "object": "line_item", "amount": 129999, "currency": "usd", "description": "My First Invoice Item (created for API docs)", "discount_amounts": [], "discountable": true, "discounts": [], "livemode": false, "metadata": {}, "parent": { "type": "invoice_item_details", "invoice_item_details": { "invoice_item": "ii_1NpHiK2eZvKYlo2C9NdV8VrI", "proration": false, "proration_details": { "credited_items": null }, "subscription": null } }, "period": { "end": 1694467932, "start": 1694467932 }, "pricing": { "price_details": { "price": "price_1NpEIa2eZvKYlo2CXcy5DRPA", "product": "prod_OcTFTbV7qh48bd" }, "type": "price_details", "unit_amount_decimal": "129999" }, "quantity": 1, "taxes": [] } ]}Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
Parameters
- linesarray of objectsRequired
The line items to add.
- invoice_
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.
Returns
The updated invoice with newly added line items is returned upon success. Otherwise, this call raises an error.
{ "id": "in_1NuhUa2eZvKYlo2CWYVhyvD9", "object": "invoice", "account_country": "US", "account_name": "Stripe.com", "account_tax_ids": null, "amount_due": 998, "amount_paid": 0, "amount_overpaid": 0, "amount_remaining": 998, "amount_shipping": 0, "application": null, "attempt_count": 0, "attempted": false, "auto_advance": false, "automatic_tax": { "enabled": false, "liability": null, "status": null }, "billing_reason": "manual", "collection_method": "charge_automatically", "created": 1695758664, "currency": "usd", "custom_fields": null, "customer": "cus_9s6XKzkNRiz8i3", "customer_address": null, "customer_email": "test@test.com", "customer_name": null, "customer_phone": null, "customer_shipping": null, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discounts": [], "due_date": null, "effective_at": null, "ending_balance": null, "footer": null, "from_invoice": null, "hosted_invoice_url": null, "invoice_pdf": null, "issuer": { "type": "self" }, "last_finalization_error": null, "latest_revision": null, "lines": { "object": "list", "data": [ { "id": "il_1NuhUa2eZvKYlo2CC98Fg3Bo", "object": "line_item", "amount": 799, "currency": "usd", "description": "test description", "discount_amounts": [], "discountable": true, "discounts": [], "livemode": false, "metadata": {}, "parent": { "type": "invoice_item_details", "invoice_item_details": { "invoice_item": "ii_1NuhUa2eZvKYlo2CGeF7Qgx0", "proration": false, "proration_details": { "credited_items": null }, "subscription": null } }, "period": { "end": 1695758664, "start": 1695758664 }, "pricing": { "price_details": { "price": "price_1NuhLA2eZvKYlo2Cq1tIGEBp", "product": "prod_Oi7aO1GPi1dWX7" }, "type": "price_details", "unit_amount_decimal": "799" }, "quantity": 1, "taxes": [] }, { "id": "il_1NuLVe2eZvKYlo2Canh35EfU", "object": "line_item", "amount": 199, "currency": "usd", "description": "Canned Coffee", "discount_amounts": [], "discountable": true, "discounts": [], "livemode": false, "metadata": {}, "parent": { "type": "invoice_item_details", "invoice_item_details": { "invoice_item": "ii_1NuLVd2eZvKYlo2CRWY0Hqgi", "proration": false, "proration_details": { "credited_items": null }, "subscription": null } }, "period": { "end": 1695674161, "start": 1695674161 }, "pricing": { "price_details": { "price": "price_1NuI212eZvKYlo2CWgdD8kET", "product": "prod_OhhQNWDYdIbXYv" }, "type": "price_details", "unit_amount_decimal": "199" }, "quantity": 1, "taxes": [] } ], "has_more": false, "url": "/v1/invoices/upcoming/lines?customer=cus_9s6XKzkNRiz8i3" }, "livemode": false, "metadata": {}, "next_payment_attempt": null, "number": null, "on_behalf_of": null, "paid": false, "paid_out_of_band": false, "parent": null, "payment_intent": null, "payment_settings": { "default_mandate": null, "payment_method_options": null, "payment_method_types": null }, "period_end": 1688482163, "period_start": 1688395763, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "receipt_number": null, "redaction": null, "rendering": null, "shipping_cost": null, "shipping_details": null, "starting_balance": 0, "statement_descriptor": null, "status": "draft", "status_transitions": { "finalized_at": null, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subtotal": 998, "subtotal_excluding_tax": 998, "test_clock": null, "total": 998, "total_discount_amounts": [], "total_excluding_tax": 998, "total_taxes": [], "webhooks_delivered_at": null}