---
title: "Get billing finance overview"
method: GET
path: "/admin/billing/finance/overview"
tags: ["Billing"]
---

# Get billing finance overview

`GET /admin/billing/finance/overview`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/admin/billing/finance/overview`
- Auth: API key in header `x-api-key`

Admin-only endpoint that returns current MRR, at-risk MRR, booked revenue, cash collected, current outstanding A/R, and per-plan breakdown for the requested time window. Without an explicit time range, the overview defaults to the last 30 days.

## Query parameters

- `from` string
- `to` string
- `plan` 'Free' | 'Starter' | 'Growth' | 'Pro' | 'Business' | 'Enterprise' | 'Admin'
- `exclude_test_accounts` boolean

## Headers

- `x-api-key` string, required

## Response `200`

Billing finance overview

- BillingBillingFinanceOverviewResponseDoc
  - `code` integer
  - `data` BillingBillingFinanceOverviewDoc
    - `active_customers` integer
    - `at_risk_mrr_cents` integer
    - `booked_expected_total_cents` integer
    - `booked_overage_cents` integer
    - `booked_subscription_cents` integer
    - `cancel_scheduled_customers` integer
    - `cancel_scheduled_mrr_cents` integer
    - `cash_collected_cents` integer
    - `currency` string
    - `current_outstanding_ar_cents` integer
    - `grace_period_customers` integer
    - `invoice_count` integer
    - `invoiced_amount_due_cents` integer
    - `mismatch_invoice_count` integer
    - `mismatch_total_cents` integer
    - `mrr_cents` integer
    - `paid_invoice_count` integer
    - `past_due_customers` integer
    - `payment_failed_invoice_count` integer
    - `plan_breakdown` BillingBillingFinancePlanBreakdownDoc[]
      - `active_customers` integer
      - `at_risk_mrr_cents` integer
      - `booked_expected_total_cents` integer
      - `booked_overage_cents` integer
      - `booked_subscription_cents` integer
      - `cancel_scheduled_customers` integer
      - `cancel_scheduled_mrr_cents` integer
      - `cash_collected_cents` integer
      - `current_outstanding_ar_cents` integer
      - `customers` integer
      - `grace_period_customers` integer
      - `invoice_count` integer
      - `invoiced_amount_due_cents` integer
      - `mismatch_invoice_count` integer
      - `mismatch_total_cents` integer
      - `mrr_cents` integer
      - `paid_invoice_count` integer
      - `past_due_customers` integer
      - `payment_failed_invoice_count` integer
      - `plan` string
      - `retained_mrr_cents` integer
      - `stripe_actual_credit_note_cents` integer
      - `stripe_actual_discount_cents` integer
      - `stripe_actual_net_cash_cents` integer
      - `stripe_actual_refund_cents` integer
      - `stripe_actual_tax_cents` integer
      - `stripe_actual_total_cents` integer
      - `uncollectible_invoice_count` integer
      - `voided_invoice_count` integer
    - `retained_mrr_cents` integer
    - `stripe_actual_credit_note_cents` integer
    - `stripe_actual_discount_cents` integer
    - `stripe_actual_net_cash_cents` integer
    - `stripe_actual_refund_cents` integer
    - `stripe_actual_tax_cents` integer
    - `stripe_actual_total_cents` integer
    - `uncollectible_invoice_count` integer
    - `voided_invoice_count` integer
  - `msg` string

## Other responses

- `400`: Invalid query parameters
- `401`: Authentication required
- `403`: Admin plan required
- `500`: Internal server error

---

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