*REST API › Objects › Account & access*

# Account

> The account that made the request, its key and its usage limits.

The account that made the request: its name, timezone, currency, country and language, the add-ons it has, whether it is in trial, the API key that made the call with its scopes, the usage limits and the version of the contract. It is read-only and it is the first call of any integration, because it tells you how to read dates and amounts and which resources answer 402. Read it with [`GET /api/v1/account`](https://docs.filmo.io/rest-api/endpoint-reference/account/get-the-account).

Schemas: `AccountDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `name` | string | Name of the account. |
| `timezone` | string | IANA timezone of the business, the one bare days in filters are read in. |
| `currency` | string | ISO 4217 currency of the account; documents may carry their own. |
| `country` | string | ISO 3166-1 alpha-2 country of the business. |
| `language` | string | Default language of error messages for this key (BCP 47), unless Accept-Language says otherwise. |
| `addons` | string[] | Ids of the add-ons the account has access to today. A resource behind an add-on not listed here responds 402. `platform`, `user-seat`, `connected-account`, `extra-tax-cif`, `qr-codes`, `incidence`, `purchases`, `activity-log`, `custom-fields`, `profitability`, `web-builder`, `crm`, `consignments`, `email-calendar`, `sales-documents`, `internal-bookings`, `internal-communication`, `advanced-user-permissions`, `ai-pack-25k`, `ai-pack-55k`, `ai-pack-115k` |
| `trial` | object | Trial period of the account. |
| `trial.active` | boolean | true while the trial of the account lasts: every add-on is unlocked. |
| `trial.endsAt` | string<date-time> | End of the trial in ISO 8601 UTC; null if none. |
| `apiKey` | object | The key that made the request. Never its secret. |
| `apiKey.id` | string | Identifier of the API key that made the request. |
| `apiKey.name` | string | Name given to the key when it was created. |
| `apiKey.scopes` | string[] | Scopes granted to the key, the ones its requests can use. |
| `rateLimits` | object | Usage limits of the key, the ones the RateLimit-* headers report. |
| `rateLimits.global` | object | Requests per minute across the whole API. |
| `rateLimits.global.perMinute` | integer |  |
| `rateLimits.availability` | object | Requests per minute of the availability checks, counted apart. |
| `rateLimits.availability.perMinute` | integer |  |
| `api` | object | The contract this account is served with. |
| `api.version` | string | Version of the public API contract. |
| `api.docsUrl` | string | Where the documentation of this version lives. |

## Values

| Field | Values |
| --- | --- |
| `addons` | `platform`, `user-seat`, `connected-account`, `extra-tax-cif`, `qr-codes`, `incidence`, `purchases`, `activity-log`, `custom-fields`, `profitability`, `web-builder`, `crm`, `consignments`, `email-calendar`, `sales-documents`, `internal-bookings`, `internal-communication`, `advanced-user-permissions`, `ai-pack-25k`, `ai-pack-55k`, `ai-pack-115k` |

## Example

*Account · Generated from the schema*

```json
{
  "name": "Example",
  "timezone": "string",
  "currency": "EUR",
  "country": "ES",
  "language": "es-ES",
  "addons": [
    "platform"
  ],
  "trial": {
    "active": true,
    "endsAt": "2026-09-01T08:00:00Z"
  },
  "apiKey": {
    "id": "id_8f2a1c",
    "name": "Example",
    "scopes": [
      "string"
    ]
  },
  "rateLimits": {
    "global": {
      "perMinute": 1
    },
    "availability": {
      "perMinute": 1
    }
  },
  "api": {
    "version": "string",
    "docsUrl": "https://example.com"
  }
}
```

## Returned by

- [`GET /api/v1/account`](https://docs.filmo.io/rest-api/endpoint-reference/account/get-the-account) — Get the account

## Modified by

No operation.

---

Canonical URL: https://docs.filmo.io/rest-api/objects/account  
Last updated: 2026-10-25