---
title: "Each app's plan, what is used and what is left"
method: GET
path: "/account/usage"
tags: ["Account"]
---

# Each app's plan, what is used and what is left

`GET /account/usage`

## Request

- Base URL: `https://pagefully.com/api/v1`
- URL: `https://pagefully.com/api/v1/account/usage`
- Auth: HTTP bearer

## Response `200`

Usage.

- Usage
  - `workspace` object, required
    - `id` string, uuid, required
    - `name` string, required
  - `token` object, required
    - `scope` string, required
    - `client` string, required
  - `apps` object[], required
    - `app_id` string, uuid, required
    - `name` string, required
    - `plan` string, required
    - `billing` string, nullable, required: For Pro: year or month.
    - `pages` object, required
      - `made` integer, required: New pages ever generated. On Free and the Pack a deleted page still counts.
      - `allowed` integer, required
      - `held` integer, required
      - `at_apple_already` integer, required
      - `left` integer, required
      - `stopped_by` string, nullable, required: plan, month or apple.
    - `new_pages_this_month` object, nullable, required
      - `used` integer, required
      - `allowed` integer, required
    - `revisions` object, required
      - `allowed_a_page` integer, nullable, required
      - `pages` object[], required
        - `page_id` string, uuid, required
        - `name` string, required
        - `times_sent` integer, required
        - `used` integer, required
        - `left` integer, nullable, required
    - `regenerations` object, required
      - `left` integer, nullable, required
      - `allowed` integer, required
    - `results` boolean, required
    - `upgrade_url` string, required
  - `plans` object, required: What Free, the Pack and Pro allow and cost.
  - `rate_limits` object, required
    - `requests_a_minute` integer, required
    - `generation_starts_an_hour` integer, required
    - `screenshot_reads_a_day` integer, required
    - `screenshots_read_of_a_set` integer, required

## Other responses

- `401`: No token, or one that is not valid or has been revoked.
- `429`: Too many calls: 120 requests a minute for a token, and 20 generation starts an hour. `retry_after` is seconds.

---

[API](https://skmtc.dev/pagefully/apis/pagefully-api.md) · [All operations](https://skmtc.dev/pagefully/apis/pagefully-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pagefully/apis/pagefully-api/revisions/60e17ce09d31?raw)