Plans / Change plan

Change plan for tenant

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

Method: POST

Authorisation: Minimum role: OWNER

Request Arguments
Name Type Source
inputDTO_tenant_change_plan_inputBody

  Request body example

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
NameTypeReadOnlyDescription
planENUM tenant_planPlan
DTO_plan_limits
NameTypeReadOnlyDescription
current_planENUM tenant_planCurrent plan
plansDTO_plan_limit[]Plans
usageDTO_plan_limitUsage
DTO_plan_limit
NameTypeReadOnlyDescription
planENUM tenant_planPlan
price_usdDoublePrice usd
listsInt32Lists
list_entriesInt32List entries
fieldsInt32Fields
groupsInt32Groups
email_domainsInt32Email domains
imported_email_messagesInt32Imported email messages
formsInt32Forms
kbsInt32Kbs
ticketsInt32Tickets
automation_rulesInt32Automation rules
scrape_domainsInt32Scrape domains
ENUM tenant_plan
ValueNameDescription
0UNKNOWNUNKNOWN
1FREEFREE
2SMALLSMALL
3MEDIUMMEDIUM
4LARGELARGE

left_arrow GET Plans / Get limits

POST Scrape domains / Create right_arrow