Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Stripe Accounts Account Item API
description: This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
contact:
email: dev-platform@stripe.com
name: Stripe Dev Platform Team
url: https://stripe.com
termsOfService: https://stripe.com/us/terms/
version: '2023-10-16'
x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Item
paths:
/v1/invoices/{invoice}/lines/{line_item_id}:
post:
description: '<p>Updates an invoice’s line item. Some fields, such as <code>tax_amounts</code>, only live on the invoice line item,
so they can only be updated through this endpoint. Other fields, such as <code>amount</code>, 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.</p>'
operationId: postInvoicesInvoiceLinesLineItemId
parameters:
- description: Invoice ID of line item
in: path
name: invoice
required: true
schema:
maxLength: 5000
type: string
style: simple
- description: Invoice line item ID
in: path
name: line_item_id
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
discounts:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
period:
explode: true
style: deepObject
price_data:
explode: true
style: deepObject
tax_amounts:
explode: true
style: deepObject
tax_rates:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostInvoicesInvoiceLinesLineItemIdRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/line_item'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Invoices Invoice Lines Line Item Id
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
ChooseTags: true
tags:
- Item
components:
schemas:
PostInvoicesInvoiceLinesLineItemIdRequest:
type: object
properties:
amount:
description: 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.
type: integer
description:
description: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
maxLength: 5000
type: string
discountable:
description: 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.
type: boolean
discounts:
anyOf:
- items:
properties:
coupon:
maxLength: 5000
type: string
discount:
maxLength: 5000
type: string
title: discounts_data_param
type: object
type: array
- enum:
- ''
type: string
description: The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.
period:
description: 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](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
properties:
end:
format: unix-time
type: integer
start:
format: unix-time
type: integer
required:
- end
- start
title: period
type: object
price:
description: The ID of the price object.
maxLength: 5000
type: string
price_data:
description: Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
properties:
currency:
type: string
product:
maxLength: 5000
type: string
product_data:
properties:
description:
maxLength: 40000
type: string
images:
items:
type: string
type: array
metadata:
additionalProperties:
type: string
type: object
name:
maxLength: 5000
type: string
tax_code:
maxLength: 5000
type: string
required:
- name
title: product_data
type: object
tax_behavior:
enum:
- exclusive
- inclusive
- unspecified
type: string
unit_amount:
type: integer
unit_amount_decimal:
format: decimal
type: string
required:
- currency
title: one_time_price_data_with_product_data
type: object
quantity:
description: Non-negative integer. The quantity of units for the line item.
type: integer
tax_amounts:
anyOf:
- items:
properties:
amount:
type: integer
tax_rate_data:
properties:
country:
maxLength: 5000
type: string
description:
maxLength: 5000
type: string
display_name:
maxLength: 50
type: string
inclusive:
type: boolean
jurisdiction:
maxLength: 50
type: string
percentage:
type: number
state:
maxLength: 2
type: string
tax_type:
enum:
- amusement_tax
- communications_tax
- gst
- hst
- igst
- jct
- lease_tax
- pst
- qst
- rst
- sales_tax
- service_tax
- vat
type: string
required:
- display_name
- inclusive
- percentage
title: tax_rate_data_param
type: object
taxable_amount:
type: integer
required:
- amount
- tax_rate_data
- taxable_amount
title: tax_amount_param
type: object
type: array
- enum:
- ''
type: string
description: A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
tax_rates:
anyOf:
- items:
maxLength: 5000
type: string
type: array
- enum:
- ''
type: string
description: The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
error:
description: An error response from the Stripe API
properties:
error:
$ref: '#/components/schemas/api_errors'
required:
- error
type: object
invoice:
description: 'Invoices are statements of amounts owed by a customer, and are either
generated one-off, or generated periodically from a subscription.
They contain [invoice items](https://stripe.com/docs/api#Invoice Items), and proration adjustments
that may be caused by subscription upgrades/downgrades (if necessary).
If your invoice is configured to be billed through automatic charges,
Stripe automatically finalizes your invoice and attempts payment. Note
that finalizing the invoice,
[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does
not happen immediately as the invoice is created. Stripe waits
until one hour after the last webhook was successfully sent (or the last
webhook timed out after failing). If you (and the platforms you may have
connected to) have no webhooks configured, Stripe waits one hour after
creation to finalize the invoice.
If your invoice is configured to be billed by sending an email, then based on your
[email settings](https://dashboard.stripe.com/account/billing/automatic),
Stripe will email the invoice to your customer and await payment. These
emails can contain a link to a hosted page to pay the invoice.
Stripe applies any customer credit on the account before determining the
amount due for the invoice (i.e., the amount that will be actually
charged). If the amount due for the invoice is less than Stripe''s [minimum allowed charge
per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the
invoice is automatically marked paid, and we add the amount due to the
customer''s credit balance which is applied to the next invoice.
More details on the customer''s credit balance are
[here](https://stripe.com/docs/billing/customer/balance).
Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)'
properties:
account_country:
description: The country of the business associated with this invoice, most often the business creating the invoice.
maxLength: 5000
type:
- string
- 'null'
account_name:
description: The public name of the business associated with this invoice, most often the business creating the invoice.
maxLength: 5000
type:
- string
- 'null'
account_tax_ids:
description: The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
items:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/tax_id'
- $ref: '#/components/schemas/deleted_tax_id'
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/tax_id'
- $ref: '#/components/schemas/deleted_tax_id'
type:
- array
- 'null'
amount_due:
description: Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.
type: integer
amount_paid:
description: The amount, in cents (or local equivalent), that was paid.
type: integer
amount_remaining:
description: The difference between amount_due and amount_paid, in cents (or local equivalent).
type: integer
amount_shipping:
description: This is the sum of all the shipping amounts.
type: integer
application:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/application'
- $ref: '#/components/schemas/deleted_application'
description: ID of the Connect Application that created the invoice.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/application'
- $ref: '#/components/schemas/deleted_application'
application_fee_amount:
description: The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
type:
- integer
- 'null'
attempt_count:
description: Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.
type: integer
attempted:
description: Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
type: boolean
auto_advance:
description: Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
type: boolean
automatic_tax:
$ref: '#/components/schemas/automatic_tax'
billing_reason:
description: 'Indicates the reason why the invoice was created.
* `manual`: Unrelated to a subscription, for example, created via the invoice editor.
* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
* `subscription_create`: A new subscription was created.
* `subscription_cycle`: A subscription advanced into a new period.
* `subscription_threshold`: A subscription reached a billing threshold.
* `subscription_update`: A subscription was updated.
* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.'
enum:
- automatic_pending_invoice_item_invoice
- manual
- quote_accept
- subscription
- subscription_create
- subscription_cycle
- subscription_threshold
- subscription_update
- upcoming
type:
- string
- 'null'
charge:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/charge'
description: ID of the latest charge generated for this invoice, if any.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/charge'
collection_method:
description: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
enum:
- charge_automatically
- send_invoice
type: string
created:
description: Time at which the object was created. Measured in seconds since the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
custom_fields:
description: Custom fields displayed on the invoice.
items:
$ref: '#/components/schemas/invoice_setting_custom_field'
type:
- array
- 'null'
customer:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/customer'
- $ref: '#/components/schemas/deleted_customer'
description: The ID of the customer who will be billed.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/customer'
- $ref: '#/components/schemas/deleted_customer'
customer_address:
anyOf:
- $ref: '#/components/schemas/address'
description: The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
customer_email:
description: The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
maxLength: 5000
type:
- string
- 'null'
customer_name:
description: The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.
maxLength: 5000
type:
- string
- 'null'
customer_phone:
description: The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.
maxLength: 5000
type:
- string
- 'null'
customer_shipping:
anyOf:
- $ref: '#/components/schemas/shipping'
description: The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.
customer_tax_exempt:
description: The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.
enum:
- exempt
- none
- reverse
type:
- string
- 'null'
customer_tax_ids:
description: The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
items:
$ref: '#/components/schemas/invoices_resource_invoice_tax_id'
type:
- array
- 'null'
default_payment_method:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/payment_method'
description: ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/payment_method'
default_source:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/bank_account'
- $ref: '#/components/schemas/card'
- $ref: '#/components/schemas/source'
description: ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/bank_account'
- $ref: '#/components/schemas/card'
- $ref: '#/components/schemas/source'
x-stripeBypassValidation: true
default_tax_rates:
description: The tax rates applied to this invoice, if any.
items:
$ref: '#/components/schemas/tax_rate'
type: array
description:
description: An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
maxLength: 5000
type:
- string
- 'null'
discount:
anyOf:
- $ref: '#/components/schemas/discount'
description: Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
discounts:
description: The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
items:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/discount'
- $ref: '#/components/schemas/deleted_discount'
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/discount'
- $ref: '#/components/schemas/deleted_discount'
type:
- array
- 'null'
due_date:
description: The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.
format: unix-time
type:
- integer
- 'null'
effective_at:
description: The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
format: unix-time
type:
- integer
- 'null'
ending_balance:
description: Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
type:
- integer
- 'null'
footer:
description: Footer displayed on the invoice.
maxLength: 5000
type:
- string
- 'null'
from_invoice:
anyOf:
- $ref: '#/components/schemas/invoices_from_invoice'
description: Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
hosted_invoice_url:
description: The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
maxLength: 5000
type:
- string
- 'null'
id:
description: Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.
maxLength: 5000
type: string
invoice_pdf:
description: The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
maxLength: 5000
type:
- string
- 'null'
last_finalization_error:
anyOf:
- $ref: '#/components/schemas/api_errors'
description: The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
latest_revision:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/invoice'
description: The ID of the most recent non-draft revision of this invoice
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/invoice'
lines:
description: 'The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.'
properties:
data:
description: Details about each object.
items:
$ref: '#/components/schemas/line_item'
type: array
has_more:
description: True if this list has another page of items after this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: InvoiceLinesList
type: object
x-expandableFields:
- data
livemode:
description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
type:
- object
- 'null'
next_payment_attempt:
description: The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
format: unix-time
type:
- integer
- 'null'
number:
description: A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
maxLength: 5000
type:
- string
- 'null'
object:
description: String representing the object's type. Objects of the same type share the same value.
enum:
- invoice
type: string
on_behalf_of:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/account'
description: The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/account'
paid:
description: Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
type: boolean
paid_out_of_band:
description: Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.
type: boolean
payment_intent:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/payment_intent'
description: The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/payment_intent'
payment_settings:
$ref: '#/components/schemas/invoices_payment_settings'
period_end:
description: End of the usage period during which invoice items were added to this invoice.
format: unix-time
type: integer
period_start:
description: Start of the usage period during which invoice items were added to this invoice.
format: unix-time
type: integer
post_payment_credit_notes_amount:
description: Total amount of all post-payment credit notes issued for this invoice.
type: integer
pre_payment_credit_notes_amount:
description: Total amount of all pre-payment credit notes issued for this invoice.
type: integer
quote:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/quote'
description: The quote this invoice was generated from.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/quote'
receipt_number:
description: This is the transaction number that appears on email receipts sent for this invoice.
maxLength: 5000
type:
- string
- 'null'
rendering:
anyOf:
- $ref: '#/components/schemas/invoices_invoice_rendering'
description: The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
shipping_cost:
anyOf:
- $ref: '#/components/schemas/invoices_shipping_cost'
description: The details of the cost of shipping, including the ShippingRate applied on the invoice.
shipping_details:
anyOf:
- $ref: '#/components/
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-item-api-openapi.yml