Lightbug Documentation
Search K

Appearance

Summary of plans​

GET
/users/plansSummary

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

Authorizations​

ApiKeyAuth
Type: API Key (header: Authorization)

Parameters​

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
}
}
]

Samples​

cURL
curl -X GET \
'http://localhost:8080/v2/users/plansSummary' \
 -H "Content-Type: application/json"
JavaScript
fetch('http://localhost:8080/v2/users/plansSummary', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'http://localhost:8080/v2/users/plansSummary';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'http://localhost:8080/v2/users/plansSummary'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())