Plans
Get limits
Returns the plans the workspace can choose between with the limits of each, together with the workspace's current usage per limit and its trial state.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/plans/get_limits
Request arguments
| Name | Type | Source |
|---|
Request body example
Response
Response body example
DTO_plan_limits
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| current_plan | ENUM tenant_plan | Current plan | |
| is_trial | Boolean | Is trial | |
| trial_end_date | DateTime (nullable) | Trial end date | |
| expired_trial | Boolean | Expired trial | |
| capped_amount | DTO_capped_amount | Capped amount | |
| plans | DTO_plan_limit[] | Plans | |
| usage | DTO_plan_limit | Usage |
DTO_capped_amount
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| is_shopify_payment | Boolean | ReadOnly | Is shopify payment |
| current_user_count | Int32 | ReadOnly | Current user count |
| current_invite_count | Int32 | ReadOnly | Current invite count |
| require_increase | Boolean | ReadOnly | Require increase |
| minimum_required_cap | Double | ReadOnly | Minimum required cap |
| current_cap | Double | ReadOnly | Current cap |
DTO_plan_limit
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| plan | ENUM tenant_plan | Plan | |
| price_usd | Double | Price usd | |
| price_usd_minimum | Double | Price usd minimum | |
| tickets | Int32 | Tickets | |
| included_tickets_per_month | Int32 | Included billable tickets per UTC calendar month. | |
| overage_price_per_1000_usd | Decimal | Price in USD per 1,000 additional tickets; billed per ticket. | |
| included_chat_sessions_per_month | Int32 | Included chat sessions per UTC calendar month. | |
| chat_session_price_per_1000_usd | Decimal | Price in USD per 1,000 additional chat sessions. | |
| retention_months | Int32 | Configured retention period in months; deletion is not enabled by this setting. | |
| max_num_integrations | Int32 | Included integrations. | |
| ai_suggested_answers | Boolean | Ai suggested answers | |
| mailboxes | Int32 | Mailboxes | |
| kbs | Int32 | Kbs | |
| web_scraped_pages | Int32 | Web scraped pages | |
| integration_shopify_customer_card | Boolean | Integration shopify customer card | |
| integration_shopify_product_sync | Int32 | Was a bool hardcoded true, which hid a limit that is actually enforced (PlanSpecs.MaxNumShopifyProductsSync, PlanUsageEntity.SHOPIFY_PRODUCTS_SYNC). The public pricing page has always advertised it as a per-plan number, so this now carries the number. | |
| automation_rules | Int32 | Automation rules | |
| forms | Int32 | Forms | |
| multilingual_conversations | Boolean | Multilingual conversations | |
| ai_training_data | Boolean | Ai training data | |
| sso_google_microsoft | Boolean | Sso google microsoft | |
| api_access | Boolean | Api access | |
| lists | Int32 | Lists | |
| list_entries | Int32 | List entries | |
| fields | Int32 | Fields | |
| groups | Int32 | Groups | |
| sla_policies | Boolean | The only feature flag here backed by real data (PlanSpec.EnableSla, per-tenant override on PlanSpecDeviation.EnableSla, plus the global TempEnableSla kill switch). Everything below is hardcoded true - included on every plan - and exists so the in-app plan table lists the same features as the public pricing page. | |
| statistics | Boolean | Statistics | |
| email_attachment_reading | Boolean | Email attachment reading | |
| ai_chat_bot | Boolean | Ai chat bot | |
| public_faq | Boolean | Public faq | |
| auto_replies_from_faq | Boolean | Auto replies from faq | |
| insights | Boolean | Insights | |
| chat_bot_sessions | Int32 | NOT ENFORCED. The public pricing page advertises 500/2000/5000 sessions per month, but nothing in the backend counts or caps them - there is no PlanSpecs column and no PlanUsageEntity. Surfaced here so the in-app plan table can state the same thing the customer was sold; move it to real plan data if the limit is ever implemented, and populate DTO_plan_limits.usage for it at the same time. | |
| notifications_and_mentions | Boolean | Notifications and mentions | |
| ticket_forwarding | Boolean | Ticket forwarding | |
| agents_included | Int32 | Agents included | |
| free_trial_days | Int32 | Free trial days |
ENUM tenant_plan
Tenant plans
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | FREE | FREE |
| 2 | SMALL | SMALL |
| 3 | MEDIUM | MEDIUM |
| 4 | LARGE | LARGE |
Generated Sep 18, 2026 09:32