Plan

List tariff tiers

The tiers of one kind with every limit, the add-on catalogue and the prices, ordered by creation (grid order). Unlimited is `-1` in every limit; every key of the kind is listed. Prices are tier-level only and null where the tier has no list price (Custom). Requires WorkspacePlanIndex (kind=workspace) or TenantPlanIndex (kind=tenant): root, Owner, SuperAdmin.

GET
/api/v2/plans

Authorization

BearerAuthObject
AuthorizationBearer <token>

In: header

Query Parameters

kind*string

Whom the tiers are sold to

Value in

  • "workspace"
  • "tenant"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/plans?kind=workspace"
{  "plans": [    {      "code": "starter",      "name": "Starter",      "kind": "workspace",      "priceMonthUsd": 69,      "priceYearUsd": 690,      "limits": [        {          "key": "max_keys",          "value": 6000        }      ],      "addons": [        {          "code": "keys_500",          "limitKey": "max_keys",          "delta": 500,          "maxQty": 8,          "priceUsd": 5        }      ]    }  ]}
{  "errors": {    "name": "Empty value"  }}
{  "message": {    "error": "Your request was made with invalid credentials."  }}
{  "message": {    "error": "You are not allowed to perform this action."  }}
{  "message": {    "error": "Oops! Something went wrong! Write to administrator. Your Request Id {f1177aee-9a99-42f0-a23f-4dd29fc39b65-672e0df972ccb}"  }}