Plans / Get limits

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/plans/get_limits

Method: GET

Authorisation: Minimum role: ADMIN

Request Arguments
Name Type Source

  Request body example

No input arguments
Response object

Response status: 200 (OK)

Response type: DTO_plan_limits

Wrapper: DTO_response_wrap

Other response statuses: 400 (BadRequest), 403 (Forbidden)

  Response body example

DTO_plan_limits
NameTypeReadOnlyDescription
current_planENUM tenant_planCurrent plan
is_trialBooleanIs trial
trial_end_dateDateTime (nullable)Trial end date
expired_trialBooleanExpired trial
capped_amountDTO_capped_amountCapped amount
plansDTO_plan_limit[]Plans
usageDTO_plan_limitUsage
DTO_capped_amount
NameTypeReadOnlyDescription
is_shopify_paymentBooleanReadOnlyIs shopify payment
current_user_countInt32ReadOnlyCurrent user count
current_invite_countInt32ReadOnlyCurrent invite count
require_increaseBooleanReadOnlyRequire increase
minimum_required_capDoubleReadOnlyMinimum required cap
current_capDoubleReadOnlyCurrent cap
DTO_plan_limit
NameTypeReadOnlyDescription
planENUM tenant_planPlan
price_usdDoublePrice usd
price_usd_minimumDoublePrice usd minimum
ticketsInt32Tickets
ai_suggested_answersBooleanAi suggested answers
mailboxesInt32Mailboxes
kbsInt32Kbs
web_scraped_pagesInt32Web scraped pages
integration_shopify_customer_cardBooleanIntegration shopify customer card
integration_shopify_product_syncBooleanIntegration shopify product sync
automation_rulesInt32Automation rules
formsInt32Forms
multilingual_conversationsBooleanMultilingual conversations
ai_training_dataBooleanAi training data
sso_google_microsoftBooleanSso google microsoft
api_accessBooleanApi access
listsInt32Lists
list_entriesInt32List entries
fieldsInt32Fields
groupsInt32Groups
agents_includedInt32Agents included
free_trial_daysInt32Free trial days
ENUM tenant_plan
ValueNameDescription
0UNKNOWNUNKNOWN
1FREEFREE
2SMALLSMALL
3MEDIUMMEDIUM
4LARGELARGE

left_arrow PUT Notifications / Group notification

POST Plans / Change plan right_arrow