Skip to main content
GET
/
v1
/
status
Get your account's subscription status
curl --request GET \
  --url https://dev.api.nestapi.com/v1/status \
  --header 'Accept: <accept>' \
  --header 'Authorization: <api-key>'
import requests

url = "https://dev.api.nestapi.com/v1/status"

headers = {
"Accept": "<accept>",
"Authorization": "<api-key>"
}

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

print(response.text)
const options = {method: 'GET', headers: {Accept: '<accept>', Authorization: '<api-key>'}};

fetch('https://dev.api.nestapi.com/v1/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.api.nestapi.com/v1/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://dev.api.nestapi.com/v1/status"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Accept", "<accept>")
req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://dev.api.nestapi.com/v1/status")
.header("Accept", "<accept>")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dev.api.nestapi.com/v1/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "HasHadTrail": true,
  "IsOnTrial": true,
  "HasTrialRequest": true,
  "RequiresPayment": true,
  "NestingAccountBalance": {
    "UserId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "RemainingAllowanceSeconds": 123,
    "RemainingAllowance": 123,
    "RemainingCredit": 123,
    "IsOnTrial": true,
    "PaidUntil": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Response

200 - application/json

Success

UserSubscriptionStatus

HasHadTrail
boolean
IsOnTrial
boolean
HasTrialRequest
boolean
RequiresPayment
boolean
NestingAccountBalance
NestingAccountBalance · object

NestingAccountBalance