# AUM Fee API reference

Source: https://docs.settlemint.com/docs/api-reference/token-features/aum-fee
API reference for configuring AUM Fee, reading accrued estimates, collecting fees, freezing the rate, and listing collection events.



The `aum-fee` token feature accrues an annual management fee against time-weighted token supply. This page is the endpoint reference. Use [Configure and operate AUM Fee](/docs/operators/token-features/aum-fee) for the task flow. Use [AUM Fee architecture](/docs/architects/components/token-features/aum-fee) for the canonical model, dilution mechanics, and events.

## Configuration during token creation [#configuration-during-token-creation]

```json
{
  "aum-fee": {
    "feeBps": 200,
    "recipient": "0x..."
  }
}
```

| Parameter   | Type             | Required | Description                                                  |
| ----------- | ---------------- | -------- | ------------------------------------------------------------ |
| `feeBps`    | Integer          | Yes      | Annualised fee rate in basis points. `200` = 2.00% per year. |
| `recipient` | Ethereum address | Yes      | Wallet that receives the collected fee.                      |

## Reading accrued fees [#reading-accrued-fees]

```http
GET /api/v2/tokens/{tokenAddress}/aum-fee/accrued-estimate
```

Returns the current accrued-fee estimate in token units, the configured annual rate, the last collection time, the measurement time, and the attached feature contract address. The response `data` is `null` when the token has no attached and initialised AUM Fee feature.

## Collecting accrued fees [#collecting-accrued-fees]

```http
POST /api/v2/tokens/{tokenAddress}/features/aum-fee/collections
```

Queues an async blockchain mutation that calls the AUM Fee collection flow. Collection mints newly issued token units to the configured `recipient`. It does not transfer existing treasury tokens.

## Updating parameters [#updating-parameters]

Update each governance-controlled parameter through its own endpoint. These calls are blocked after the rate and recipient are frozen.

```http
PATCH /api/v2/tokens/{tokenAddress}/features/aum-fee/bps
PATCH /api/v2/tokens/{tokenAddress}/features/aum-fee/recipient
POST /api/v2/tokens/{tokenAddress}/features/aum-fee/rate-freezes
```

Collect before changing the rate or recipient when the accounting period needs a clean cut-off. The next estimate and collection use the current configuration against elapsed time since the last collection.

## Listing collection events [#listing-collection-events]

```http
GET /api/v2/tokens/{tokenAddress}/aum-fee/collection-events
```

Returns indexed `AUMFeeCollected` events for the attached feature. The collection supports DataTable filtering, sorting, and pagination. Useful response fields include `collector`, `recipient`, `feeAmount`, `feeAmountExact`, `eventTimestamp`, `blockNumber`, `blockTimestamp`, `txHash`, and `logIndex`. Filter and sort collections by `collectedAt`, `blockNumber`, `collector`, `recipient`, and `feeAmount`.

## Related [#related]

* [AUM Fee operator guide](/docs/operators/token-features/aum-fee)
* [AUM Fee architecture](/docs/architects/components/token-features/aum-fee)
* [Funds use case](/docs/business/use-cases/funds)
* [Token lifecycle](/docs/api-reference/tokens/token-lifecycle)