The Invoice Item object
Invoice Items represent the component lines of an invoice. When you create an invoice item with an invoice field, it is attached to the specified invoice and included as an invoice line item within invoice.lines. Invoice items can be created before you are ready to send the invoice, which is useful with subscriptions when you want to add a charge or credit that settles with the customer's wallet at the end of a billing cycle.
Attributes
id string Unique identifier for the object. Zoneless invoice item IDs are prefixed with ii_z_.
object string String representing the object's type. Objects of the same type share the same value.
amount integer Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity. For USDC, this is cents (e.g., 100 = $1 USDC).
currency enum Three-letter currency code, in lowercase. For Zoneless, this is usdc.
Difference from Stripe: Uses usdc instead of fiat currency codes like usd.
customernullable string The ID of the customer to bill for this invoice item. null when using customer_account.
customer_accountnullable string The ID of the account to bill for this invoice item.
date timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
descriptionnullable string An arbitrary string attached to the object. Often useful for displaying to users.
discountable boolean If true, discounts will apply to this invoice item. Always false for prorations.
discountsnullable array of strings The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
invoicenullable string The ID of the invoice this invoice item belongs to.
livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadatanullable object 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.
period object The period associated with this invoice item. When set to different values, the period will be rendered on the invoice.
pricingnullable object The pricing information of the invoice item.
proration boolean Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
quantity integer 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_decimal decimal string Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.
More attributes
{
"id": "ii_z_1QfGHtLkdIwHu7ixBYwjAM42",
"object": "invoiceitem",
"amount": 2500,
"currency": "usdc",
"customer": "cus_z_KmR4eUfNV2Hib",
"customer_account": null,
"date": 1721415600,
"created": 1721415600,
"description": "Studio license",
"discountable": true,
"discounts": [],
"invoice": null,
"livemode": false,
"metadata": {},
"net_amount": null,
"parent": null,
"period": {
"end": 1721415600,
"start": 1721415600
},
"pricing": {
"price_details": {
"price": "price_z_1QfGHsLkdIwHu7ix1be5Ljaj",
"product": "prod_z_KmR47xbBdJT8EN"
},
"type": "price_details",
"unit_amount_decimal": "2500"
},
"proration": false,
"proration_details": null,
"quantity": 1,
"quantity_decimal": "1",
"tax_rates": [],
"test_clock": null,
"platform_account": "acct_z_Platform123abc"
}