Superfy Platform API Documentation


Get Specific Account Type Information and Given Modules API

Require Authentication

This API is used to get specific account type information and its given modules in Superfy Platform system.


URL

api/general/accounttypedetail/:licenseTypeID

Required parameter (in URL)

Optional parameter

Example JSON Payload


Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "licenseTypeID": 1,
    "licenseTypeName": "Town Plan",
    "allowTrial": "Y",
    "price": [
      {
        "locale": "AU",
        "currencyCode": "AUD",
        "price": 79,
        "paymentPeriod": "monthly"
      }
    ],
    "user_limit": 1,
    "project_limit": 1,
    "pin_limit": 100,
    "modules": [
      {
        "moduleName": "project_limit",
        "value": 1
      },
      {
        "moduleName": "user_limit",
        "value": 1
      }
    ]
  }
}

Note:
"licensePeriod": empty string means unlimited period (no expired date). "+30 days" means account only valid until 30 days after registration date.
"paymentPeriod" may contain "monthly" (for monthly payment / monthly subscription), "annually" (for annual payment / annual subscription), or "onetime" (for one time payment only).
"user_limit" contains number of allowed users in the same company. If its value is -1, it means that it is unlimited.
"project_limit" contains number of allowed projects in the same company. If its value is -1, it means that it is unlimited.
"pin_limit" contains number of allowed pins/bins/assets in all projects in the same company. If its value is -1, it means that it is unlimited.