Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

The unique identifier of the item

Pattern: ^itm_[a-zA-Z0-9]+$

Body

application/json
name
string
catalogId
string | null

The product this item belongs to.

Pattern: ^prod_[a-zA-Z0-9]+$
archived
boolean

Set to true to retire this item from your catalog, or false to restore it. Archived items remain readable and continue to resolve on historical invoices. Archiving also releases this item's claim on its external codes: any reference it holds as primary becomes non-primary, freeing that (provider, externalId) for a replacement item while the reference stays attached so this item's own invoice lines keep resolving it. Restoring the item does not reclaim primary status. Archiving is rejected while live billableMetrics or fees are anchored to the item — re-tag or retire those charges first.

metadata
object

Response

Item updated

id
string
required

Unique identifier for an item

Pattern: ^itm_[a-zA-Z0-9]+$
object
enum<string>
default:item
required
Available options:
item
merchantId
string
required
Pattern: ^org_[a-zA-Z0-9]+$
name
string
required
metadata
object
required
externalReferences
object[]
required
catalogId
string | null
required

The product this item belongs to.

Pattern: ^prod_[a-zA-Z0-9]+$
archivedAt
string<date-time> | null
required
read-only

When this item was retired from the catalog. Null while active.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required