Skip to main content
PATCH
Update a fee schedule

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Path Parameters

scheduleId
string
required

The unique identifier of the fee schedule.

Body

application/json

Fee schedule updates

Payload for updating a fee schedule

name
string

Updated display name

Maximum string length: 100
Example:

"Updated Schedule"

applicationOrder
enum<string>

Updated application order

Available options:
PARALLEL,
CASCADING
Example:

"CASCADING"

roundingScale
integer

Updated number of decimal places

Example:

4

roundingMode
enum<string>

Updated rounding method

Available options:
HALF_UP,
BANKERS,
FLOOR,
CEIL,
TRUNCATE
Example:

"BANKERS"

Response

Successfully updated fee schedule.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

Fee schedule with its fee items

id
string<uuid>

Unique identifier for the fee schedule

Example:

"019c96a0-2b20-7123-9a1b-2c3d4e5f6a7b"

tenantId
string<uuid>

Tenant that owns this fee schedule

Example:

"019c96a0-0a98-7287-9a31-786e0809c769"

name
string

Display name for the fee schedule

Maximum string length: 100
Example:

"Card Processing - Visa"

currency
string

Currency code (ISO 4217)

Example:

"USD"

applicationOrder
enum<string>

How multiple fee items compose

Available options:
PARALLEL,
CASCADING
Example:

"PARALLEL"

roundingScale
integer

Number of decimal places for rounding

Example:

2

roundingMode
enum<string>

Rounding method for intermediate calculations

Available options:
HALF_UP,
BANKERS,
FLOOR,
CEIL,
TRUNCATE
Example:

"HALF_UP"

items
object[]

Fee items in this schedule

Maximum array length: 100
createdAt
string<date-time>

Creation timestamp in RFC 3339 format

Example:

"2025-01-15T10:30:00Z"

updatedAt
string<date-time>

Last update timestamp in RFC 3339 format

Example:

"2025-01-15T10:30:00Z"