List frozen months

GET /api/v2/external/exchange-rate-freezes

Authentication: x-api-key header, with the exchange-rate-freezes:write scope. See Authentication and limits.

Returns the months (YYYY-MM) for which the client has frozen exchange rates.

Response

200 The frozen months.

json

[
  {
    "object": "exchangeRateFreeze",
    "yearMonth": "2026-10"
  }
]

Response fields

Field	Type	Description
`[].object`	string	String describing the object type (auto-description). One of: `exchangeRateFreeze`.
`[].yearMonth`	string	Frozen month, YYYY-MM.

Errors use the application/problem+json envelope with stable machine-readable codes. See the Errors guide.

Status	Description
401	Missing or invalid API key (`invalid_api_key`), or expired key (`api_key_expired`).
403	API key lacks the required scope (`insufficient_scope`, with `requiredScope` extension) or the operation is not enabled for this client (`forbidden`).
429	Daily API call limit exceeded (`rate_limit_exceeded`): the `Retry-After` header gives the seconds until reset.

bash

curl "https://api.renewr.example/api/v2/external/exchange-rate-freezes" \
  -H "x-api-key: $RENEWR_API_KEY"