Get Plan Comparison

GET 
/organizations/:organizationId/plans/compare

Compare current plan with target plan for downgrade warning (V2 API)

Request

Path Parameters

organizationId stringrequired

Organization ID

Query Parameters

targetPlan stringrequired

Target plan ID (lite, basic, professional, enterprise)

Responses

200

application/json

Schema

Schema

data objectrequired
Plan comparison data
currentPlan objectrequired
targetPlan objectrequired
isDowngrade booleanrequired
featuresLost object[]required
Array [
]
limitChanges object[]required
Array [
]
recommendation object

Example (from schema)

{
  "data": {
    "currentPlan": {},
    "targetPlan": {},
    "isDowngrade": true,
    "featuresLost": [
      {}
    ],
    "limitChanges": [
      {}
    ],
    "recommendation": {}
  }
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

Loading...