Skip to main content
PATCH
Update billable_items

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Path Parameters

id
integer
required

Body

application/json
description
string

The item's name as shown on invoices, up to 255 characters.

Maximum string length: 255
type
enum<string>

service or product.

Available options:
service,
product
amount
string

Unit price in the account currency, two decimal places. Negative amounts are allowed (discounts).

Pattern: ^-?\d+(\.\d{1,2})?$
Example:

"45.00"

tax_id
integer | null

Tax rate applied (taxes are managed in Settings › Billing); null for none.

modality_id
integer | null

Restrict the item to one practitioner modality; null for all.

sku
string | null

Optional stock-keeping code.

Maximum string length: 255
stock_alert_level
integer | null

Products only: alert when stock falls to this level; null for no alert.

Required range: x >= 0
active
boolean

Whether the item can still be billed. Deactivate instead of deleting; there is no DELETE.

metadata
object

Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically.

Response

The resource

data
object
Example: