Skip to content

Get the current plan

get/current-plan
Workspace key

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

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

Try it · GET /current-plan
curl 'https://api.chat-data.com/api/v2/current-plan' \  -H "Authorization: Bearer $CHAT_DATA_API_KEY"
Loading…

Responses

Successful response.

Content type: application/json

FieldDescription
statusstringOne of: success.
emailstringThe email address of the workspace owner.
namestringThe name of the workspace owner.
planobjectThe workspace's current plan.
plan.subscriptionsobjectThe 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.
plan.subscriptions.freenumberQuantity of the Free plan in the workspace.
plan.subscriptions.entrynumberQuantity of the Entry plan in the workspace.
plan.subscriptions.standardnumberQuantity of the Standard plan in the workspace.
plan.subscriptions.professionalnumberQuantity of the Professional plan in the workspace.
plan.subscriptions.extra_messagesnumberQuantity of the Extra Message Credits add-on in the workspace.
plan.subscriptions.extra_chatbotsnumberQuantity of the Extra Chatbots add-on in the workspace.
plan.subscriptions.remove_brandnumberQuantity of the Reseller plan in the workspace.
plan.subscriptions.remove_labelnumberQuantity of the Remove 'Powered by Chat Data' add-on in the workspace.
plan.subscriptions.live_chatnumberQuantity of the Live Chat add-on in the workspace.
plan.subscriptions.webhook_deliverynumberQuantity of the Webhook Delivery add-on in the workspace.
plan.subscriptions.storagenumberQuantity of the 10GB Storage add-on in the workspace.
plan.subscriptions.sso_loginnumberQuantity of the SSO Login add-on in the workspace.
plan.subscriptions.customize_plan_1numberQuantity of the Enterprise plan in the workspace.
plan.subscriptions.scrapenumberQuantity of the legacy monthly scrape credits subscription in the workspace.
plan.subscriptions.entry_legacynumberHow many of the entry subscriptions are on the Entry plan as sold before August 2026.
plan.remainingTrainingCharsnumberThe number of characters currently available for training or retraining chatbots in the workspace. Remaining characters do not carry over to the next billing period.
plan.refreshingTrainingCharsnumberThe number of training characters the plan grants each billing period.
plan.remainingCreditsnumberThe 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.
plan.refreshingCreditsnumberThe number of message credits that renew each billing period.
plan.chatbotsnumberThe number of chatbots in the workspace.
plan.chatbotsLimitnumberThe maximum number of chatbots allowed in the workspace.
plan.chatbotCharactersLimitnumberThe 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.
plan.gatherLeadsbooleanWhether the workspace can collect customer information through the chatbot.
plan.customDomainbooleanWhether the chatbot can be hosted under a custom domain.
plan.apibooleanWhether the workspace can use the API.
plan.customModelbooleanWhether the workspace can use its own model as the backend for the chatbot widget UI.
plan.userAnalysisbooleanWhether the workspace can access aggregated user analysis statistics.
plan.shareAnalysisbooleanWhether the workspace can share a chatbot's analytics publicly.
plan.notificationbooleanWhether the workspace can receive daily email notifications.
plan.gpt4booleanWhether the workspace can use GPT-4 models to answer questions.
plan.removeBrandbooleanWhether 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.
plan.filesnumberThe file storage limit of the workspace, in MB.

Example

{  "status": "success",  "email": "[email protected]",  "name": "Jane Doe",  "plan": {    "subscriptions": {      "free": 1,      "entry": 0,      "standard": 1,      "professional": 0,      "customize_plan_1": 0,      "extra_chatbots": 0,      "extra_messages": 0,      "live_chat": 0,      "remove_brand": 0,      "remove_label": 0,      "webhook_delivery": 0,      "sso_login": 0,      "storage": 0,      "scrape": 0,      "entry_legacy": 0    },    "remainingTrainingChars": 50000000,    "refreshingTrainingChars": 110000000,    "remainingCredits": 5000,    "refreshingCredits": 10000,    "chatbots": 2,    "chatbotsLimit": 5,    "chatbotCharactersLimit": 11000000,    "gatherLeads": true,    "customDomain": true,    "api": true,    "customModel": true,    "userAnalysis": true,    "shareAnalysis": true,    "notification": true,    "gpt4": true,    "removeBrand": false,    "files": 2560  }}

Last updated October 14, 2026