v4

latestOpenAPI 3.0.02026-07-12228151.6 MB

Create an invoice item

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

post/v1/invoiceitems

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

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.