---
title: "Billing overview for platform operators: accounts by plan, past due, restricted, MRR, failed webhooks"
method: GET
path: "/operator/billing/overview"
tags: ["Operator"]
---

# Billing overview for platform operators: accounts by plan, past due, restricted, MRR, failed webhooks

`GET /operator/billing/overview`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/operator/billing/overview`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Response `200`

Overview

- object
  - `configured` boolean, required
  - `accounts` object, required
    - `total` integer, required
    - `paid` integer, required
    - `trialing` integer, required
    - `pastDue` integer, required
    - `restricted` integer, required
    - `byPlan` object, required
  - `mrr` integer, required: minor units (cents)
  - `openInvoicesAmount` integer, required: minor units (cents)
  - `failedWebhookEvents` integer, required
  - `lastWebhookAt` string, nullable, required: ISO-8601 timestamp
  - `recentFailedEvents` object[], required
    - `id` string, required
    - `type` string, required
    - `status` 'processing' | 'processed' | 'ignored' | 'failed', required
    - `attempts` integer, required
    - `lastError` string, nullable, required
    - `organizationId` string, uuid, nullable, required
    - `receivedAt` string, required: ISO-8601 timestamp
    - `processedAt` string, nullable, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden); details.requiresSession for plan/payment changes over a token
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state, e.g. a subscription already exists (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `501`: Billing is not set up on this server (code not_configured)
- `503`: The payment provider is unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)