Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

The unique identifier of the fee Unique identifier for a fee

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

Body

application/json
description
string

Revised explanation of what the fee represents.

name
string

Updated label for the fee.

itemId
string | null

Optional item tag, used to map this fee's invoice lines to an external accounting/tax identity. Send a new id to re-tag — the item must be filed under this charge's own product, and an archived item is rejected. An item from another product is refused with ITEM_PRODUCT_MISMATCH: a tag is an accounting grouping and does not move the charge between products, and no field here could move it back. Re-file the item to move every charge anchored to it together. Send null to untag. Every line item whose invoice has not closed reports this charge's current tag, so a re-tag takes effect on the bill in progress and on any generated ahead of it — no further action, and no window to wait for. Lines on a closed invoice keep the item recorded at close and never move. Un-tagging works the same way: those lines report no item.

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

Response

Fee updated successfully

id
string
required
Pattern: ^fee_[a-zA-Z0-9]+$
object
enum<string>
default:fee
required
Available options:
fee
name
string
required
description
string
required
merchantId
string
required

Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
productId
string
required

The product this fee belongs to. Always populated; derived from the item's catalog when the fee is tagged with an item.

Pattern: ^prod_[a-zA-Z0-9]+$
itemId
string | null
required

The item this fee is tagged with, or null when untagged. Used to map this fee's invoice lines to an external accounting/tax identity.

Pattern: ^itm_[a-zA-Z0-9]+$
createdAt
string<date-time>
required
updatedAt
string<date-time>
required