Invoice items
Create, retrieve, update, delete, and list line items on draft invoices.
An invoice item is a single line item added to a draft invoice. You can attach items to an existing draft or create them without an invoice to be auto-collected on the customer's next invoice.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The invoice item objectAsk
idstringUnique identifier for the invoice item, e.g. ii_7Yz1c4Nq.
invoiceobjectExpandableThe invoice this item belongs to, if assigned. Expand to retrieve the full object.
customerobjectExpandableThe customer this item is billed to. Expand to retrieve the full object.
amountintegerTotal amount for this line item, in the smallest currency unit (e.g. cents).
currencystringThree-letter ISO currency code, e.g. EUR.
descriptionstringHuman-readable description of the item, shown on the invoice.
quantityintegerNumber of units. Defaults to 1.
unit_amountintegerPer-unit amount in the smallest currency unit. amount equals unit_amount * quantity.
createdintegerUnix timestamp of when the item was created.
Create an invoice itemAsk
Adds a line item to a draft invoice. Omit invoice to create a pending item that will be included
on the customer's next automatically generated invoice.
Retrieve an invoice itemAsk
Update an invoice itemAsk
Updates the description or amount on a draft invoice item. Only items on draft invoices may be
modified.
Delete an invoice itemAsk
Removes an item from a draft invoice. Deleted items cannot be recovered.
List invoice itemsAsk
Returns invoice items, optionally filtered by customer or invoice.
Related eventsAsk
invoiceitem.created, invoiceitem.updated, and invoiceitem.deleted. See Events.
