Accounts

You will need to verify your account details over time. Be it to check your plan or the amount of credits that you have. On this page, we'll learn how to query your account status.

The account model

The account model contains the status of the account. There's an active plan that an account currently subscribing to. There are also the remaining credits of the month.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier of the account.

  • Name
    plan
    Type
    string
    Description

    Active plan of the account.

  • Name
    credits
    Type
    integer
    Description

    Remaining credits of the month.

  • Name
    created_at
    Type
    string
    Description

    ISO 8601 date and time of account creation.


GET/v1/status

Status

This endpoint allows you to retrieve the details of your account. Note that the credits will reset at the beginning of every month.

Request

GET
/v1/status
curl -G https://api.browserhub.io/v1/status \
  -H "Authorization: Bearer {API key}"

Response

{
  "id": "5e2174db-7879-4695-8dab-1b3544481c6e",
  "plan": "Pro Monthly",
  "credits": 1567,
  "created_at": "2023-02-09T02:23:18Z"
}