Skip to main content
GET
Get 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.

Path Parameters

​
scheduleId
string<uuid>
required

The unique identifier of the fee schedule. Schedule ID

Response

Successfully retrieved fee schedule

​
applicationOrder
enum<string>
required

How items combine. PARALLEL applies every item to the same gross base; CASCADING applies each item to the net remaining after prior items.

Available options:
PARALLEL,
CASCADING
Example:

"PARALLEL"

​
createdAt
string
required

Creation timestamp in RFC 3339 format.

Example:

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

​
currency
string
required

ISO 4217 currency code the schedule's amounts are denominated in.

Example:

"USD"

​
id
string
required

Unique identifier of the fee schedule.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
items
object[] | null
required

Fee items that make up the schedule.

Maximum array length: 100
​
name
string
required

Human-readable name of the fee schedule.

Example:

"Card Processing - Visa"

​
roundingMode
enum<string>
required

Rounding strategy. HALF_UP rounds halves away from zero; BANKERS rounds halves to the nearest even digit; FLOOR rounds down; CEIL rounds up; TRUNCATE drops extra digits.

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

"HALF_UP"

​
roundingScale
integer<int64>
required

Number of decimal places fee amounts are rounded to.

Example:

2

​
tenantId
string
required

Identifier of the tenant that owns the schedule.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
updatedAt
string
required

Last update timestamp in RFC 3339 format.

Example:

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

​
usedByContexts
integer<int64>
required

Number of distinct contexts whose fee rules reference this schedule. Computed at read time from the fee rules that reference this schedule (never persisted).

Example:

2