iotoms Docs

Get a merchant's plan

GET
/api/v1/merchant/{merchantCode}/plan

Returns the subscription plan currently assigned to the merchant identified by merchantCode, with its register limit, the features it includes and the features each role gets.

Path Parameters

merchantCode*string

The merchant's unique code, as chosen in Create a merchant account.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

The merchant's current plan assignment: tier, register limit, included features and features per role.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/merchant/string/plan'
Example Response
{  "status": "string",  "message": "string",  "data": {    "merchantCode": "string",    "planTier": "FREE",    "registerLimit": 0,    "assignedAt": "2019-08-24T14:15:22Z",    "assignedBy": "string",    "features": [      {        "code": "string",        "name": "string",        "description": "string",        "category": "string"      }    ],    "featuresByRole": {      "property1": [        {          "code": "string",          "name": "string",          "description": "string",          "category": "string"        }      ],      "property2": [        {          "code": "string",          "name": "string",          "description": "string",          "category": "string"        }      ]    }  }}