---
title: "Get usage"
method: GET
path: "/liteforms/usage"
tags: ["Liteforms"]
---

# Get usage

`GET /liteforms/usage`

Get the user's current Liteform usage.

## Response `200`

Successful response

- LiteformsUsageResponse
  - `account` object, required
    - `id` number, required
    - `email` string, nullable, required
    - `username` string, nullable, required
    - `displayName` string, nullable, required
    - `picture` string, required
    - `isSubscribed` boolean, required
    - `entitlements` object[], required
      - `type` 'LITEFORMS_BASIC' | 'LITEFORMS_PLUS' | 'LITEFORMS_CREATOR' | 'LITEFORMS_PRO', required
      - `subscriptionId` string, nullable, required
      - `period` 'MONTH' | 'YEAR', nullable, required
      - `source` 'SHOPIFY' | 'CHARGEBEE' | 'RECHARGE', nullable
    - `rpmId` string, nullable
    - `rpmToken` string, nullable
    - `liteformsCharacters` object[], required
      - `id` number
      - `name` string
      - `description` string, nullable
      - `voice` object, nullable
        - `languageTag` string, required
        - `voiceName` string, required
        - `speakingStyle` string, required
        - `pitch` string, required
        - `rate` string, required
      - `sceneId` string
      - `pronouns` 'HE' | 'SHE' | 'THEY'
      - `environmentID` string
      - `documents` object[]
        - `id` number
        - `fragmentsCollection` object[]
          - `id` number, required
          - `content` string, required
          - `metadata` unknown
          - `documentId` number, required
        - `liteformsCollection` object[]
          - `id` number, required
          - `name` string, required
          - `userId` number, required
      - `avatar_id` number, nullable
  - `usage` object, required
    - `totalSeconds` number, required — The number of seconds of usage so far.
    - `totalSecondsRemaining` number, required — The number of seconds remaining. Once this value equals zero, the rest of the API calls will fail.
    - `totalGPTTokens` number, required — The number of GPT tokens used so far.
    - `totalSTTSeconds` number, required — The number of STT seconds used so far.
    - `totalTTSSeconds` number — The number of TTS seconds used so far.
    - `totalTTSChars` number, required — The number of TTS characters used so far.
    - `totalImagesCreated` number, required — The number of images created.
    - `startedAt` string, date-time, required — The date the usage period started.
    - `resetsAt` string, date-time, required — The date the usage period will reset.

## Other responses

- `401` — Invalid authentication credentials.
- `408` — The server timed out waiting for the request.
- `500` — An unspecified error occurred.

---

[API](https://skmtc.dev/blocks/apis/looking-glass-api.md) · [All operations](https://skmtc.dev/blocks/apis/looking-glass-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/blocks/looking-glass-api/revisions/c79a9a0e44b0/schema)