Skip to main content
PATCH
Update an invoice line item

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01
Idempotency-Key
string

A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.

Maximum string length: 255
Example:

"ik_a1b2c3d4e5f6"

Path Parameters

id
string
required

Unique identifier for the invoice

line_item_id
string
required

Unique identifier for the line-item

Body

application/json
description
string | null

Description of the line item

Response

Success

amount_excluding_tax
string
required

Amount for this line before tax (quantity x unit price)

Example:

"73.98"

amount_including_tax
string
required

Amount for this line including its tax. This is the figure a full credit of the line returns.

Example:

"80.55"

description
string
required

Description of the line item

id
string
required

Unique identifier for the line item

is_editable
boolean
required

Whether this line item can be manually edited

quantity
string
required

Quantity of the line item

Example:

"1"

total_price
string
required
deprecated

Deprecated: use amount_excluding_tax, which carries the same value. Despite the name this excludes tax.

Example:

"100.00"

unit_price
string
required

Unit price of the line item, excluding tax

Example:

"100.00"

billing_period_end
string<date-time> | null

End of the service period this line covers, exclusive

billing_period_start
string<date-time> | null

Start of the service period this line covers, inclusive

product_id
string | null

Associated product identifier

tax_amount
string | null

Tax charged on this line

Example:

"6.57"

tax_rate
string | null

Percentage rate the tax was charged at

Example:

"8.875"