Account

Get the account overview

GET
/v1/overview

What you hold, what needs you and what renews by itself over the next 30 days, counted across every page. Each part your role cannot see comes back empty.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Response Body

Success

application/json
  1. response

Success

counts*

How much you hold

attention*array<>

What needs you, grouped by kind in a fixed order, only the kinds with something in them. Empty without product.read

renewals*|

What renews by itself from your wallet over the next 30 days. Null without product.read

curl -X GET "https://example.com/v1/overview"
{  "counts": {    "numbers": 0,    "domains": 0,    "seats": 0,    "mailboxes": 0,    "customers": 0  },  "attention": [    {      "kind": "licence_unpaid",      "count": 4,      "sample": [        {          "id": "dom_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",          "name": "northwind-telecom.com",          "at": "2026-10-07T11:04:31.000Z",          "amount": 1440        }      ]    }  ],  "renewals": {    "domains": {      "count": 3,      "amount": 1440    },    "numbers": {      "count": 3,      "amount": 1440    },    "licences": {      "count": 3,      "amount": 1440    }  }}