<!-- https://developers.silktide.com/v1/platform/balances/get-account-balance | Platform / Balances -->

# Get what the account can still add

`GET /v1/balances`

Returns what the account can still add under its plan: websites, pages, documents and the other allowances. Call it before creating a website to know how many pages and documents you can give it.

A value of `-1` means unlimited. Most fields count what is left, not the total: `maxPages` is the most pages a new website could be given now, while `maxPagesLimit` is the account's whole allowance and `maxPagesRestOfAccount` is what its websites already hold.

To see what one existing website could be given, use [Get what a website can be given](https://developers.silktide.com/v1/platform/balances/get-website-balance.md).

## Response

Status `200`.

- `newWebsites` (integer, required, at least -1): How many more websites the account can create.
- `maxPages` (integer, required, at least -1): The most pages a new website could be given now.
- `maxDocuments` (integer, required, at least -1): The most documents (PDFs) a new website could be given now.
- `maxAuthentications` (integer, required, at least -1): How many more website logins (authentications) the account can add.
- `maxSearchEngineKeywords` (integer, required, at least -1): How many more search engine keywords the account can track.
- `maxUptimeMonitors` (integer, required, at least -1): How many more uptime monitors the account can add.
- `maxUserFlows` (integer, required, at least -1): How many more user flows the account can add.
- `maxExperiences` (integer, required, at least -1): How many more experiences the account can add.
- `maxPagesLimit` (integer, required, at least -1): The account's whole page allowance, across every website.
- `maxDocumentsLimit` (integer, required, at least -1): The account's whole document (PDF) allowance, across every website.
- `governanceAiOptimizersLimit` (integer, required, at least -1): How many Governance AI optimizers the account's plan includes. `0` means none.
- `governanceAiOptimizersUsed` (integer, required): How many Governance AI optimizers are in use, including any still held after a website gave one up.
- `maxPagesRestOfAccount` (integer, required): Pages already allocated to the account's websites.
- `maxDocumentsRestOfAccount` (integer, required): Documents already allocated to the account's websites.

## Errors

| Status | Type | When |
| --- | --- | --- |
| 401 | `NotLoggedIn` | No API key was sent, or it is not a key for this region. |
| 429 | `TooManyRequests` | Too many requests to this path in five seconds. Retry after the number of seconds in the `Retry-After` header, which `properties.retryAfter` repeats. |
| 503 | - | Silktide is busy. Retry after the number of seconds in the `Retry-After` header. |

## Access

- Permission: any user of the account
- Plan feature: none
- Edition: Silktide 4 and Silktide 5
- Cost: free
- Stability: stable, since 1.0.0

## Example: An account with room for 95 more websites

```bash
curl "https://api.eu.silktide.com/v1/balances" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
```

Response:

```json
{
  "newWebsites": 95,
  "maxPages": 99810,
  "maxDocuments": 99830,
  "maxAuthentications": 100,
  "maxSearchEngineKeywords": 1000,
  "maxUptimeMonitors": 95,
  "maxUserFlows": 100,
  "maxExperiences": 20,
  "maxPagesLimit": 100000,
  "maxDocumentsLimit": 100000,
  "maxPagesRestOfAccount": 190,
  "maxDocumentsRestOfAccount": 170,
  "governanceAiOptimizersLimit": 3,
  "governanceAiOptimizersUsed": 1
}
```