Get Account Plan

accountPlan returns the current subscription plan of your Bolt Cloud account.
Useful for determining whether the account is on Bolt Cloud Pro or Bolt Cloud (Free).


Endpoint

GET https://cloud.boltiot.com/remote/{API_KEY}/accountPlan

Replace {API_KEY} with your Bolt Cloud API key.


Response Format

The response is a JSON object with the following fields:

Field

Type

Description

value

string

Name of the current account plan

success

number

1 on success. 0 if request fails


Example: Pro Account

Request

https://cloud.boltiot.com/remote/44b2de6b-7e68-40e7-a27f-814b58afe008/accountPlan

Response

{
"value": "Bolt Cloud Pro",
"success": 1
}

Example: Free Account

Request

https://cloud.boltiot.com/remote/857290ef-b762-43e2-bda2-e09ff4983653/accountPlan

Response

{
"value": "Bolt Cloud",
"success": 1
}

Notes for Developers and Agents

  1. The value field indicates the plan name exactly as stored in Bolt Cloud.

    • Pro account returns: "Bolt Cloud Pro"

    • Free account returns: "Bolt Cloud"

  2. Use this to gate features on the client side.
    Example logic:

    • If value equals "Bolt Cloud Pro", allow premium functionality.

    • Otherwise, restrict or show upgrade options.

  3. success equals 1 when the request is valid and the response is available.


Error Handling

If the API key is invalid or the request fails, success will be 0.

Example:

{
"success": 0
}

Recommendation: Check success before evaluating value.


Typical Usage

  • Determining feature access.

  • Showing UI prompts for upgrade.

  • Automated workflows where plan-level behavior differs.


Was this article helpful?
© 2025 Bolt IoT Documentation