Retrieve the account

GET

/account

const url = 'https://api.brrndops.com/v1/account';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.brrndops.com/v1/account \
  --header 'Authorization: Bearer <token>'

Returns the account the API key belongs to. Handy for checking a key works.

Authorizations

apiKey

Responses

200

The account.

application/json

object

object

string

Allowed value: account

string

livemode

false for sandbox keys.

boolean

plan

string

Example

{
  "object": "account",
  "id": "acct_3b0c…",
  "plan": "growth"
}

401

Missing, invalid, expired or revoked API key.

application/json

object

error

required

object

type

required

string

Allowed values: authentication_error permission_error invalid_request_error rate_limit_error quota_error api_error

code

required

string

message

required

string

param

The request field the error relates to.

string

request_id

string

Example

{
  "error": {
    "type": "authentication_error",
    "code": "parameter_missing"
  }
}

402

Production key on an account without an active plan (subscription_inactive). Sandbox keys keep working.

application/json

object

error

required

object

type

required

string

Allowed values: authentication_error permission_error invalid_request_error rate_limit_error quota_error api_error

code

required

string

message

required

string

param

The request field the error relates to.

string

request_id

string

Example

{
  "error": {
    "type": "authentication_error",
    "code": "parameter_missing"
  }
}

403

The key lacks the required scope (insufficient_scope), or the business isn’t verified yet (account_not_verified, production keys only).

application/json

object

error

required

object

type

required

string

Allowed values: authentication_error permission_error invalid_request_error rate_limit_error quota_error api_error

code

required

string

message

required

string

param

The request field the error relates to.

string

request_id

string

Example

{
  "error": {
    "type": "authentication_error",
    "code": "parameter_missing"
  }
}