curl --request GET \
--url https://console.advinservers.com/api/v1/client/account \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/account"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://console.advinservers.com/api/v1/client/account', 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://console.advinservers.com/api/v1/client/account",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://console.advinservers.com/api/v1/client/account"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.advinservers.com/api/v1/client/account")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/account")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"profile": {
"first_name": "Gordon",
"last_name": "Freeman",
"company_name": "Black Mesa Research Facility",
"address1": "1 Mesa Road",
"address2": "Sector C, Anomalous Materials Laboratory",
"city": "Socorro",
"state": "New Mexico",
"postcode": "87801",
"country": "US",
"country_name": "United States",
"phone_number": "+1 575 555 0198",
"tax_id": null
},
"balance": {
"due": "$42.00",
"overdue": "$12.00",
"credit": "$10.00",
"unpaid_invoices": 2,
"overdue_invoices": 1,
"has_due": true,
"has_overdue": true,
"currency": "USD"
},
"currency": "USD",
"email": "gordon.freeman@blackmesa.example.com",
"email_verified": true,
"portal_url": "https://clients.advinservers.com"
}{
"message": "The request could not be carried out."
}{
"message": "Unauthenticated."
}{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}{
"message": "Too Many Attempts."
}Get account details
Overview
Returns billing contact details, account email, balance, currency and the account portal URL. Missing profile values are null. email_verified is null when verification status is unknown. Balance amounts are formatted for display and include partial payments; do not parse them as numbers. Returns 400 if billing is unavailable or disabled.
Permissions
Requires the account permission account.read (View the account).
curl --request GET \
--url https://console.advinservers.com/api/v1/client/account \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/account"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://console.advinservers.com/api/v1/client/account', 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://console.advinservers.com/api/v1/client/account",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://console.advinservers.com/api/v1/client/account"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.advinservers.com/api/v1/client/account")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/account")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"profile": {
"first_name": "Gordon",
"last_name": "Freeman",
"company_name": "Black Mesa Research Facility",
"address1": "1 Mesa Road",
"address2": "Sector C, Anomalous Materials Laboratory",
"city": "Socorro",
"state": "New Mexico",
"postcode": "87801",
"country": "US",
"country_name": "United States",
"phone_number": "+1 575 555 0198",
"tax_id": null
},
"balance": {
"due": "$42.00",
"overdue": "$12.00",
"credit": "$10.00",
"unpaid_invoices": 2,
"overdue_invoices": 1,
"has_due": true,
"has_overdue": true,
"currency": "USD"
},
"currency": "USD",
"email": "gordon.freeman@blackmesa.example.com",
"email_verified": true,
"portal_url": "https://clients.advinservers.com"
}{
"message": "The request could not be carried out."
}{
"message": "Unauthenticated."
}{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}{
"message": "Too Many Attempts."
}Authorizations
Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.
Response
The record, as a JSON object. There is no envelope.
The name and address used for billing. Missing values are null, not empty strings.
Show child attributes
Show child attributes
{
"first_name": "Gordon",
"last_name": "Freeman",
"company_name": "Black Mesa Research Facility",
"address1": "1 Mesa Road",
"address2": "Sector C, Anomalous Materials Laboratory",
"city": "Socorro",
"state": "New Mexico",
"postcode": "87801",
"country": "US",
"country_name": "United States",
"phone_number": "+1 575 555 0198",
"tax_id": null
}
The current outstanding balance, including partial payments. Amounts include currency symbols and digit separators. Display these strings directly; do not parse them as numbers.
Show child attributes
Show child attributes
{
"due": "$42.00",
"overdue": "$12.00",
"credit": "$10.00",
"unpaid_invoices": 2,
"overdue_invoices": 1,
"has_due": true,
"has_overdue": true,
"currency": "USD"
}
The currency the account is billed in, or null when it is not known.
"USD"
The account email address. It cannot be changed through this endpoint.
"gordon.freeman@blackmesa.example.com"
Whether the email address is verified. Null means the billing record does not provide this information; it does not mean false.
true
A link to the external account portal, or null if no portal is configured.
"https://clients.advinservers.com"