---
title: "Get the current plan"
method: GET
path: "/current-plan"
tags: ["User Account"]
---

# Get the current plan

`GET /current-plan`

## Request

- Base URL: `https://api.chat-data.com/api/v2`
- URL: `https://api.chat-data.com/api/v2/current-plan`
- Auth: HTTP bearer

Get a summary of the workspace's current subscriptions and privileges.

This operation requires a workspace API key; chatbot-scoped keys get a 403.

## Response `200`

Successful response.

- CurrentPlanRes
  - `status` 'success', required
  - `email` string, required: The email address of the workspace owner.
  - `name` string, required: The name of the workspace owner.
  - `plan` CurrentPlan, required
    - `subscriptions` Subscriptions, required: The quantity of each plan and add-on the workspace subscribes to. A workspace without subscriptions gets `{ "free": 1 }`; otherwise every key below is listed, with 0 for items it does not subscribe to, and `free` is always 1.
      - `free` number: Quantity of the Free plan in the workspace.
      - `entry` number: Quantity of the Entry plan in the workspace.
      - `standard` number: Quantity of the Standard plan in the workspace.
      - `professional` number: Quantity of the Professional plan in the workspace.
      - `extra_messages` number: Quantity of the Extra Message Credits add-on in the workspace.
      - `extra_chatbots` number: Quantity of the Extra Chatbots add-on in the workspace.
      - `remove_brand` number: Quantity of the Reseller plan in the workspace.
      - `remove_label` number: Quantity of the Remove 'Powered by Chat Data' add-on in the workspace.
      - `live_chat` number: Quantity of the Live Chat add-on in the workspace.
      - `webhook_delivery` number: Quantity of the Webhook Delivery add-on in the workspace.
      - `storage` number: Quantity of the 10GB Storage add-on in the workspace.
      - `sso_login` number: Quantity of the SSO Login add-on in the workspace.
      - `customize_plan_1` number: Quantity of the Enterprise plan in the workspace.
      - `scrape` number: Quantity of the legacy monthly scrape credits subscription in the workspace.
      - `entry_legacy` number: How many of the `entry` subscriptions are on the Entry plan as sold before August 2026.
    - `remainingTrainingChars` number, required: The number of characters currently available for training or retraining chatbots in the workspace. Remaining characters do not carry over to the next billing period.
    - `refreshingTrainingChars` number, required: The number of training characters the plan grants each billing period.
    - `remainingCredits` number, required: The number of message credits currently available for asking questions. It includes purchased permanent credits, which carry over; plan credits do not carry over to the next billing period.
    - `refreshingCredits` number, required: The number of message credits that renew each billing period.
    - `chatbots` number, required: The number of chatbots in the workspace.
    - `chatbotsLimit` number, required: The maximum number of chatbots allowed in the workspace.
    - `chatbotCharactersLimit` number, required: The maximum number of characters that can be used to train one chatbot. The effective limit can be lower, because all chatbots in the workspace share its character capacity.
    - `gatherLeads` boolean, required: Whether the workspace can collect customer information through the chatbot.
    - `customDomain` boolean, required: Whether the chatbot can be hosted under a custom domain.
    - `api` boolean, required: Whether the workspace can use the API.
    - `customModel` boolean, required: Whether the workspace can use its own model as the backend for the chatbot widget UI.
    - `userAnalysis` boolean, required: Whether the workspace can access aggregated user analysis statistics.
    - `shareAnalysis` boolean, required: Whether the workspace can share a chatbot's analytics publicly.
    - `notification` boolean, required: Whether the workspace can receive daily email notifications.
    - `gpt4` boolean, required: Whether the workspace can use GPT-4 models to answer questions.
    - `removeBrand` boolean, required: Whether the plan removes the Chat Data branding. The "Powered by Chat Data" label can also be hidden by the Remove Label add-on, which this field does not reflect.
    - `files` number, required: The file storage limit of the workspace, in MB.

## Other responses

- `400`: An unexpected error occurred while processing the request; `message` contains the error.
- `401`: Authentication failed: the `Authorization` header is missing or not in the `Bearer <key>` format, the API key does not exist, its workspace is unavailable or has no owner, or the workspace's plan does not include API access. `message` says which.
- `403`: The request used a chatbot-scoped API key. This operation needs a workspace key.
- `429`: The workspace sent more than 600 API requests in the last minute. Wait the number of seconds given in the `Retry-After` header (and in `message`) before retrying.

---

[API](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide.md) · [All operations](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide/llms.txt) · [OpenAPI document](https://skmtc.dev/chat-data/apis/chat-data-api-schema-guide/revisions/72871007f7f0?raw)