---
title: "The agreement, and what has been used against it"
method: GET
path: "/api/usage"
tags: ["Usage"]
---

# The agreement, and what has been used against it

`GET /api/usage`

## Request

- Base URL: `https://morfee.furo.solutions`
- URL: `https://morfee.furo.solutions/api/usage`
- Auth: one of:
  - API key in header `X-Api-Key`
  - HTTP bearer

Ask this before you need it. The end date is here as well as in the 402 you get once it has passed, so an integration can warn somebody while their documents still come out.

Any scope may call this: every key may read.

## Response `200`

Plan, limits and use.

- Usage: `included` and `limit` are two different things and an integration that warns somebody has to know which one it is approaching. Going over `included` costs money and carries on; reaching `limit` stops rendering with a 402. Amounts are in cents.
  - `organization` object
    - `id` string
    - `name` string
  - `plan` string: A label, not the agreement. `custom` means the numbers were set for this customer.
  - `planUntil` string, nullable: The day the agreement ends, if it has one.
  - `planDaysLeft` integer, nullable
  - `templates` object
    - `used` integer
    - `included` integer
    - `limit` integer
  - `renders` object
    - `thisMonth` integer
    - `included` integer
    - `limit` integer
  - `price` object
    - `currency` string
    - `month` integer: Cents per month.
    - `extraRender` integer: Cents per document over `included`.
    - `extraTemplate` integer: Cents per template over `included`.

## Other responses

- `401`: No key, an unknown key or a revoked one.

---

[API](https://skmtc.dev/furo/apis/morfee.md) · [All operations](https://skmtc.dev/furo/apis/morfee/llms.txt) · [OpenAPI document](https://skmtc.dev/furo/apis/morfee/revisions/83f95f89653f?raw)