iotoms Docs

Get a subscription plan

GET
/api/v1/merchant/plans/{planCode}

Returns one subscription plan by its tier code (for example BASIC or DISTRIBUTION, case-insensitive), with its register limit and included features.

Path Parameters

planCode*string

Plan tier code, e.g. BASIC or DISTRIBUTION (case-insensitive). See List subscription plans for the valid codes; an unknown code returns 400.

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 requested subscription plan with its register limit and included features.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/merchant/plans/string'
Example Response
{  "status": "string",  "message": "string",  "data": {    "code": "FREE",    "displayName": "string",    "description": "string",    "registerLimit": 0,    "sortOrder": 0,    "isDefault": true,    "features": [      {        "code": "string",        "name": "string",        "description": "string",        "category": "string"      }    ]  }}