v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve an invoice item

Retrieves the invoice item with the given ID.

get/v1/invoiceitems/{invoiceitem}

Path parameters

invoiceitemstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

amountinteger required

Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.

currencystring currency required

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

customer_accountstring nullable

The ID of the account to bill for this invoice item.

dateinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

descriptionstring nullable

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

discountableboolean required

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

idstring required

Unique identifier for the object.

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 nullable

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.

net_amountinteger

The amount after discounts, but before credits and taxes. This field is null for discountable=true items.

object'invoiceitem' required

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

prorationboolean required

Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.

quantityinteger required

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_decimalstring decimal required

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