---
title: "Simulate fee calculation"
method: POST
path: "/v1/fee-schedules/{scheduleId}/simulate"
tags: ["Configuration Fee Schedules"]
---

# Simulate fee calculation

`POST /v1/fee-schedules/{scheduleId}/simulate`

Use this endpoint to simulate fee calculation for a given gross amount using a specific fee schedule. Returns the net amount, total fee, and per-item breakdown.

## Path parameters

- `scheduleId` string, required

## Headers

- `X-Request-Id` string
- `X-Idempotency-Key` string

## Request body

- SimulateFeeRequest — Payload for simulating fee calculation against a fee schedule
  - `grossAmount` string, required — Gross transaction amount to simulate fees on
  - `currency` string, required — Currency code (ISO 4217)

## Response `200`

Fee simulation result.

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](/en/reference/retries-idempotency) for more details.

- SimulateFeeResponse — Result of a fee simulation
  - `grossAmount` string — Original gross amount
  - `netAmount` string — Amount after fees are deducted
  - `totalFee` string — Total fee amount
  - `currency` string — Currency code (ISO 4217)
  - `items` SimulateFeeItem[] — Breakdown of individual fee items
    - `name` string — Name of the fee item
    - `fee` string — Calculated fee amount
    - `baseUsed` string — Base amount used for this fee calculation

## Other responses

- `400` — Invalid request payload
- `401` — The request lacks valid authentication credentials.
- `403` — You do not have permission to access this resource.
- `404` — Fee schedule not found
- `500` — An unexpected error occurred on the server.

---

[API](https://skmtc.net/lerian/apis/identity-plugin.md) · [All operations](https://skmtc.net/lerian/apis/identity-plugin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lerian/identity-plugin/versions/25daba385532/schema)