Account

workspace objectrequired

The workspace the key belongs to; its id is what DELETE /workspaces/{id} takes.

idstring<uuid>required

slugstringrequired

namestringrequired

regionRegionrequired

Where a workspace renders and stores. Every workspace is in eu (Frankfurt) today.

Possible values: [eu, us, apac]

organization objectrequired

idstring<uuid>required

slugstringrequired

namestringrequired

plan objectrequired

The organisation's plan.

idstringrequired

free, starter, pro, business or enterprise.

Example: pro

namestringrequired

Example: Pro

monthly_unitsintegerrequired

Units included per billing period.

period objectrequired

The current billing period: monthly from the paid subscription's billing day, or the calendar month without one.

startstring<date>required

The first day of the period.

endstring<date>required

The first day after the period.

units objectrequired

Units of the current period, counted for the whole organisation.

includedintegerrequired

Included in the plan.

usednumberrequired

Used so far.

overage_balancenumberrequired

Prepaid units from packs that are still left.

limits objectrequired

The plan's limits as the API applies them, such as rps, max_pages, max_output_mb, retention_days (null for no limit), templates, webhooks, post_processing, office, einvoice, byo_storage, channels and canary.

property name*any

The plan's limits as the API applies them, such as rps, max_pages, max_output_mb, retention_days (null for no limit), templates, webhooks, post_processing, office, einvoice, byo_storage, channels and canary.

environmentstringrequired

The key's environment.

Possible values: [live, test]

Account

{
  "workspace": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "slug": "string",
    "name": "string",
    "region": "eu"
  },
  "organization": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "slug": "string",
    "name": "string"
  },
  "plan": {
    "id": "pro",
    "name": "Pro",
    "monthly_units": 0
  },
  "period": {
    "start": "2024-07-29",
    "end": "2024-07-29"
  },
  "units": {
    "included": 0,
    "used": 0,
    "overage_balance": 0
  },
  "limits": {},
  "environment": "live"
}