Skip to main content
GET
Get account details

Authorizations

Authorization
string
header
required

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.

profile
object
required

The name and address used for billing. Missing values are null, not empty strings.

Example:
balance
object
required

The current outstanding balance, including partial payments. Amounts include currency symbols and digit separators. Display these strings directly; do not parse them as numbers.

Example:
currency
string | null
required

The currency the account is billed in, or null when it is not known.

Example:

"USD"

email
string<email>
required

The account email address. It cannot be changed through this endpoint.

Example:

"gordon.freeman@blackmesa.example.com"

email_verified
boolean | null
required

Whether the email address is verified. Null means the billing record does not provide this information; it does not mean false.

Example:

true

portal_url
string | null
required

A link to the external account portal, or null if no portal is configured.

Example:

"https://clients.advinservers.com"