Sample - Stripe API
GET/v1/invoiceitems/{invoiceitem}

Retrieve an invoice item

Retrieves an invoice item by its identifier. Use expand to request selected fields in expanded form when the returned invoice item references related objects.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
invoiceitemstringrequired
The identifier of the invoice item to retrieve. Maximum 5,000 characters.
expandarray<string>optional
Fields to expand in the response.

2 status codes
200Returns an invoice item containing its amount, currency, customer, creation time, invoice association, quantity, pricing state, and object identifier.
amountintegerrequired
Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.
currencystringrequired
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).
customerstringrequired
The ID of the customer to bill for this invoice item.
customer_accountstringoptional
The ID of the account to bill for this invoice item.
dateintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
discountablebooleanrequired
If true, discounts will apply to this invoice item. Always false for prorations.
discountsarray<string>optional
The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
frozen_fieldsarray<string>optional
Array of field names that can't be modified. Attempting to update a frozen field returns an error.
idstringrequired
Unique identifier for the object.
invoicestringoptional
The ID of the invoice this invoice item belongs to.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectoptional
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.
net_amountintegeroptional
The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:invoiceitem
parentobjectoptional
The parent that generated this invoice item.
periodobjectrequired
pricingobjectoptional
The pricing information of the invoice item.
prorationbooleanrequired
Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
proration_detailsobjectoptional
quantityintegerrequired
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_decimalstringrequired
Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
tax_ratesarray<TaxRate>optional
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.
test_clockstringoptional
ID of the test clock this invoice item belongs to.
defaultReturned when the request cannot be processed; the response contains an API error object with a required `type` field.
errorobjectrequired

Error handling

invoiceitem must be a string no longer than 5,000 characters and must identify the invoice item to retrieve. Values in expand must be strings no longer than 5,000 characters.