Skip to content

Summary of plans

GET
/users/{userid}/plans/summary

Gets a summary of plans for a user (already purchased or allocated)
This can list unused, and used plans with the consumed query parameter

Authorizations

ApiKeyAuth

API Key for authentication. Retrieval from either API version login routes, or other authentication token type. See Authentication for more details.

TypeAPI Key (header: Authorization)
ExampleeyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Parameters

Path Parameters

userid*

User ID

Typeinteger
Required

Query Parameters

consumed

Filter by plans that have already been consumed by devices or not

Typeboolean

Responses

OK
application/json
JSON
[
{
"count": 0,
"plan": {
"displayName": "string",
"features": "string",
"id": 0,
"name": "string",
"onoWhitelistId": 0,
"prices": {
"eur": [
[
]
],
"gbp": [
[
]
],
"tax": "[Circular Reference]",
"usd": [
[
]
]
},
"sku": "string",
"sleepLimit": 0,
"wakeLimit": 0
}
}
]

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python