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

# Get what a website can be given

`GET /v1/balances/{websiteId}`

Returns what one existing website can be given: the most pages and documents you can set when you [update it](https://developers.silktide.com/v1/governance/websites/update-website.md), and the account's other allowances.

`maxPages` and `maxDocuments` are never lower than what the website already holds, even when the account is over its allowance, so keeping a website's current allocation always saves. `-1` means unlimited.

## Request

### Path parameters

- `websiteId` (integer, required, at least 1): The website.

## Response

Status `200`.

- `maxPages` (integer, required, at least -1): The most pages this website can be given. Never less than it holds now.
- `maxDocuments` (integer, required, at least -1): The most documents (PDFs) this website can be given. Never less than it holds 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 allocated to the account's other websites.
- `maxDocumentsRestOfAccount` (integer, required): Documents allocated to the account's other websites.

## Errors

| Status | Type | When |
| --- | --- | --- |
| 404 | `ModelNotFound` | Nothing with that id exists in the account, or the API key's user cannot see it. |
| 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: A website that could grow to 1,000 pages

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

Response:

```json
{
  "maxPages": 1000,
  "maxDocuments": 500,
  "maxAuthentications": 100,
  "maxSearchEngineKeywords": 1000,
  "maxUptimeMonitors": 95,
  "maxUserFlows": 100,
  "maxExperiences": 20,
  "maxPagesLimit": 100000,
  "maxDocumentsLimit": 100000,
  "maxPagesRestOfAccount": 180,
  "maxDocumentsRestOfAccount": 160,
  "governanceAiOptimizersLimit": 3,
  "governanceAiOptimizersUsed": 1
}
```