Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

A merchant secret key (sk_…) sent as Authorization: Bearer <key>.

Headers

Ionic-Account
string

Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.

Pattern: ^mer_[0-9A-Za-z]{14}$
Idempotency-Key
string

A unique key that makes retries safe: the same key with the same request body returns the original response instead of repeating the operation.

Maximum string length: 255

Path Parameters

id
string
required

The invoice item id (ii_…).

Body

application/json
amount
integer
required

New total amount in minor units, in the item's existing currency.

description
string
required

The item's new label, shown on the invoice line it becomes.

Response

The updated invoice item.

id
string
required

Unique identifier for the invoice item (ii_…).

object
enum<string>
required
Available options:
invoice_item
customer
string
required

ID of the customer the item is billed to (cus_…).

description
string
required

The item's label, shown on the invoice line it becomes.

quantity
integer
required

The number of units.

unit_amount
integer
required

Per-unit price in minor units.

amount
integer
required

Total amount in minor units.

currency
string
required

Three-letter ISO currency code.

invoice
string | null
required

The invoice this item was drained onto, or null while pending.

pending
boolean
required

true while the item is not yet on an invoice (invoice is null), and false once it has been added to one.

metadata
object
required

Custom key-value pairs for your use.

created_at
integer
required

Unix epoch seconds.

updated_at
integer
required

Unix epoch seconds when the invoice item was last updated.

price
string | null

The catalog price (price_…) the item was derived from. Null when the item was created without one.