Plans / Change plan
Change plan for tenant
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/plans/change_plan
Method: POST
Authorisation: Minimum role: OWNER
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_tenant_change_plan_input
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| plan | ENUM tenant_plan | Plan | |
| capped_amount | Double | Capped amount |
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 | |
| 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 | Boolean | Integration shopify product sync | |
| 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 | |
| agents_included | Int32 | Agents included | |
| free_trial_days | Int32 | Free trial days |
ENUM tenant_plan
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | FREE | FREE |
| 2 | SMALL | SMALL |
| 3 | MEDIUM | MEDIUM |
| 4 | LARGE | LARGE |
