Stripe: Invoiceitems schemas

← Invoiceitems operations · All schemas

Create an invoice item — request body — body period

Field	Type	Presence	Description and constraints
$	object	Root	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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
end	integer	Required within parent	Format: unix-time
start	integer	Required within parent	Format: unix-time

Create an invoice item — response body

Field	Type	Presence	Description and constraints
$	object	Root	Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines). Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals. Related guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items).
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	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). Format: currency
customer	JSON	Required within parent	The ID of the customer to bill for this invoice item.
customer (anyOf 1)	string	Alternative	Maximum length: 5000
customer (anyOf 2)	Model	Alternative	Expand Create a customer — response body
customer (anyOf 3)	Model	Alternative	Expand Delete a customer — response body
customer_account	JSON	Optional
customer_account (anyOf 1)	string	Alternative	The ID of the account to bill for this invoice item. Maximum length: 5000
customer_account (anyOf 2)	null	Alternative
date	JSON	Required within parent
date (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
date (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	JSON	Optional
description (anyOf 1)	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
description (anyOf 2)	null	Alternative
discountable	boolean	Required within parent	If true, discounts will apply to this invoice item. Always false for prorations.
discounts	JSON	Optional
discounts (anyOf 1)	array	Alternative	The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
discounts (anyOf 1)[]	JSON	Each item
discounts (anyOf 1)[] (anyOf 1)	string	Alternative	Maximum length: 5000
discounts (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Get Customers Customer Discount — response body
discounts (anyOf 2)	null	Alternative
frozen_fields	array	Optional	Array of field names that can't be modified. Attempting to update a frozen field returns an error.
frozen_fields[]	string	Each item	Known values: discounts, pricing, quantity
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
invoice	JSON	Optional
invoice (anyOf 1)	JSON	Alternative	The ID of the invoice this invoice item belongs to.
invoice (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
invoice (anyOf 1) (anyOf 2)	Model	Alternative	Expand Pay an invoice — response body
invoice (anyOf 2)	null	Alternative
invoicing_rules	array	Optional	The rules that control when this invoice item is eligible for invoicing. All rules must be satisfied for the item to be invoiced.
invoicing_rules[]	Model	Each item	Expand Create an invoice item — response body — invoicing rules item
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
net_amount	JSON	Optional
net_amount (anyOf 1)	integer	Alternative	The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items.
net_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: invoiceitem
parent	JSON	Optional
parent (anyOf 1)	JSON	Alternative	The parent that generated this invoice item.
parent (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create an invoice item — response body — parent / The parent that generated this invoice item / type: subscription details
parent (anyOf 2)	null	Alternative
period	Model	Required within parent	Expand Create an invoice item — response body — period
pricing	JSON	Optional
pricing (anyOf 1)	JSON	Alternative	The pricing information of the invoice item.
pricing (anyOf 1) (anyOf 1)	Model	Alternative	Expand Update an invoice's line item — response body — pricing / The pricing information of the line item / type: price details
pricing (anyOf 2)	null	Alternative
proration	boolean	Required within parent	Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
proration_details	Model	Optional	Expand Create an invoice item — response body — proration details
quantity	JSON	Required within parent
quantity (anyOf 1)	integer	Alternative	Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the 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 invoice item is a proration, the quantity of the subscription that the proration was computed for.
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity_decimal	string	Required within parent	Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item. Format: decimal
tax_rates	JSON	Optional
tax_rates (anyOf 1)	array	Alternative	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.
tax_rates (anyOf 1)[]	Model	Each item	Expand Create a tax rate — response body
tax_rates (anyOf 2)	null	Alternative
test_clock	JSON	Optional
test_clock (anyOf 1)	JSON	Alternative	ID of the test clock this invoice item belongs to.
test_clock (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
test_clock (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a test clock — response body
test_clock (anyOf 2)	null	Alternative

Referenced models: Create an invoice item — response body — parent / The parent that generated this invoice item / type: subscription details, Update an invoice's line item — response body — pricing / The pricing information of the line item / type: price details, Create a customer — response body, Delete a customer — response body, Get Customers Customer Discount — response body, Pay an invoice — response body, Create an invoice item — response body — period, Create an invoice item — response body — invoicing rules item, Create an invoice item — response body — proration details, Create a tax rate — response body, Create a test clock — response body

Create an invoice item — response body — invoicing rules item

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	The type of invoicing rule. Known values: defer_until_credited_items_resolved

Create an invoice item — response body — parent / The parent that generated this invoice item / type: subscription details

Field	Type	Presence	Description and constraints
$	object	Root
subscription_details	JSON	Optional
subscription_details (anyOf 1)	JSON	Alternative	Details about the subscription that generated this invoice item
subscription_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create an invoice item — response body — parent / The parent that generated this invoice item / type: subscription details subscription details value subscription, subscription item
subscription_details (anyOf 2)	null	Alternative
type	string	Required within parent	The type of parent that generated this invoice item Known values: subscription_details

Referenced models: Create an invoice item — response body — parent / The parent that generated this invoice item / type: subscription details subscription details value subscription, subscription item

Create an invoice item — response body — parent / The parent that generated this invoice item / type: subscription details subscription details value subscription, subscription item

Field	Type	Presence	Description and constraints
$	object	Root
subscription	string	Required within parent	The subscription that generated this invoice item Maximum length: 5000
subscription_item	string	Optional	The subscription item that generated this invoice item Maximum length: 5000

Create an invoice item — response body — period

Field	Type	Presence	Description and constraints
$	object	Root
end	JSON	Required within parent
end (anyOf 1)	integer	Alternative	The end of the period, which must be greater than or equal to the start. This value is inclusive. Format: unix-time
end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start	JSON	Required within parent
start (anyOf 1)	integer	Alternative	The start of the period. This value is inclusive. Format: unix-time
start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create an invoice item — response body — proration details

Field	Type	Presence	Description and constraints
$	object	Root
credited_items	JSON	Optional
credited_items (anyOf 1)	JSON	Alternative	For a credit proration, links to the debit invoice line items or invoice item that the credit applies to.
credited_items (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create an invoice item — response body — proration_details / credited_items / value / type: invoice item, invoice line items
credited_items (anyOf 2)	null	Alternative
discount_amounts	array	Required within parent	Discount amounts applied when the proration was created. This field is only populated for prorations created from subscriptions with `billing_mode=flexible`.
discount_amounts[]	Model	Each item	Expand Void a credit note — response body — discount amounts item

Referenced models: Void a credit note — response body — discount amounts item, Create an invoice item — response body — proration_details / credited_items / value / type: invoice item, invoice line items

Create an invoice item — response body — proration_details / credited_items / value / type: invoice item, invoice line items

Field	Type	Presence	Description and constraints
$	object	Root
invoice_item	string	Optional	When `type` is `invoice_item`, the invoice item id for the debited invoice item corresponding to this credit proration. Maximum length: 5000
invoice_line_item_details	Model	Optional	Expand Create an invoice item — response body — proration_details / credited_items / value / type: invoice item, invoice line items invoice line item details
type	string	Required within parent	Whether the credit references a pending invoice item or one or more invoice line items on an invoice. Known values: invoice_item, invoice_line_items

Referenced models: Create an invoice item — response body — proration_details / credited_items / value / type: invoice item, invoice line items invoice line item details

Create an invoice item — response body — proration_details / credited_items / value / type: invoice item, invoice line items invoice line item details

Field	Type	Presence	Description and constraints
$	object	Root
invoice	string	Required within parent	The invoice id for the debited line item(s). Maximum length: 5000
invoice_line_items	array	Required within parent	IDs of the debited invoice line item(s) on the invoice that correspond to the credit proration.
invoice_line_items[]	string	Each item	Maximum length: 5000

Delete an invoice item — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: invoiceitem