---
title: "Rates, billable sites, MRR, ARR and contracted ARR for every client"
method: GET
path: "/billing/overview"
tags: ["billing"]
---

# Rates, billable sites, MRR, ARR and contracted ARR for every client

`GET /billing/overview`

## Request

- Base URL: `https://api.verdun.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.verdun.ai/billing/overview`
- Auth: HTTP bearer

## Response `200`

Successful Response

- GetBillingOverviewResponse
  - `totals` BillingTotals, required
    - `mrr_cents` integer, required: Monthly recurring revenue across every client, in cents.
    - `arr_cents` integer, required: Annual recurring revenue: MRR x 12, in cents.
    - `billable_sites` integer, required: Billable sites.
    - `non_billable_sites` integer, required: Sites marked not billable.
    - `billable_cameras` integer, required: Cameras on billable sites.
    - `unpriced_cameras` integer, required: Cameras on billable sites with no rate anywhere up their chain.
    - `contracted_arr_cents` integer, required: Sum of every recorded contracted ARR, in cents.
    - `contracted_live_arr_cents` integer, required: Live ARR of just the clients that have a contracted ARR, in cents: the numerator of live_to_contracted_ratio.
    - `live_to_contracted_ratio` number, nullable: contracted_live_arr_cents / contracted_arr_cents; null when no contract is recorded or they sum to $0.
  - `parents` BillingParent[], required: Every live client with its accounts, sites and cameras.
    - `id` string, uuid, required: Client id.
    - `name` string, required: Client name.
    - `rate_cents` integer, nullable: The client's base per-camera monthly rate in cents; null when not set.
    - `mrr_cents` integer, required: Monthly revenue from this client's billable sites, in cents.
    - `arr_cents` integer, required: Live ARR: this client's MRR x 12, in cents.
    - `contracted_arr_cents` integer, nullable: The annual amount the client contracted for, in cents, entered by the owner; null when not recorded.
    - `live_to_contracted_ratio` number, nullable: arr_cents / contracted_arr_cents (0.5 = live is half the contract, shown as 50%); null when no contract is recorded or it is $0.
    - `billable_sites` integer, required: Billable sites.
    - `billable_cameras` integer, required: Cameras on billable sites.
    - `unpriced_cameras` integer, required: Cameras on billable sites with no rate.
    - `accounts` BillingAccount[], required: The client's live accounts.
      - `id` string, uuid, required: Account id.
      - `name` string, required: Account name.
      - `rate_cents` integer, nullable: This account's override, or null when it inherits the client rate.
    - `sites` BillingSite[], required: The client's live sites.
      - `id` string, uuid, required: Site id.
      - `name` string, required: Site name.
      - `account_id` string, uuid, nullable: The site's live account, or null when it sits directly under the client.
      - `stage` string, nullable: 'test' or 'live' (display label).
      - `billable` boolean, required: Whether this site's cameras count toward MRR.
      - `rate_cents` integer, nullable: This site's own override, or null when it inherits.
      - `inherited_rate_cents` integer, nullable: What a camera here without its own override bills at (site, then account, then client).
      - `inherited_rate_source` 'parent' | 'account' | 'site' | 'camera', nullable: Which level inherited_rate_cents comes from; null when unpriced.
      - `camera_count` integer, required: Non-deleted cameras on the site.
      - `mrr_cents` integer, required: This site's monthly revenue in cents; 0 when not billable.
      - `unpriced_cameras` integer, required: Counted cameras with no rate anywhere up their chain (0 when not billable).
      - `cameras` BillingCamera[], required: The site's cameras.
        - `id` string, uuid, required: Camera id.
        - `label` string, required: Camera label.
        - `rate_cents` integer, nullable: This camera's own override, or null when it inherits.
        - `effective_rate_cents` integer, nullable: The rate this camera bills at, or null when no level up its chain has a rate (unpriced).
        - `rate_source` 'parent' | 'account' | 'site' | 'camera', nullable: Which level the effective rate comes from; null when unpriced.

---

[API](https://skmtc.dev/verdun/apis/verdun-api.md) - [All operations](https://skmtc.dev/verdun/apis/verdun-api/llms.txt) - [OpenAPI document](https://skmtc.dev/verdun/apis/verdun-api/revisions/35a2a6ebedda?raw)