Billing

Get billing finance overview

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.

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

Query parameters

fromstring

Booked/cash lower bound in RFC3339 format

tostring

Booked/cash upper bound in RFC3339 format

plan'Free' | 'Starter' | 'Growth' | 'Pro' | 'Business' | 'Enterprise' | 'Admin'

Billing plan

exclude_test_accountsboolean

Exclude sandbox accounts and Stripe test data

Headers

x-api-keystring required

Admin API key required unless an Admin JWT is already present

Response

Billing finance overview

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "active_customers": 10,
    "at_risk_mrr_cents": 20800,
    "booked_expected_total_cents": 121900,
    "booked_overage_cents": 3200,
    "booked_subscription_cents": 118700,
    "cancel_scheduled_customers": 1,
    "cancel_scheduled_mrr_cents": 2900,
    "cash_collected_cents": 114100,
    "currency": "usd",
    "current_outstanding_ar_cents": 7800,
    "grace_period_customers": 1,
    "invoice_count": 15,
    "invoiced_amount_due_cents": 121900,
    "mrr_cents": 118700,
    "paid_invoice_count": 13,
    "past_due_customers": 1,
    "payment_failed_invoice_count": 1,
    "plan_breakdown": [
      {
        "active_customers": 10,
        "at_risk_mrr_cents": 15800,
        "booked_expected_total_cents": 98000,
        "booked_overage_cents": 3200,
        "booked_subscription_cents": 94800,
        "cancel_scheduled_customers": 1,
        "cancel_scheduled_mrr_cents": 2900,
        "cash_collected_cents": 90200,
        "current_outstanding_ar_cents": 7800,
        "customers": 12,
        "grace_period_customers": 1,
        "invoice_count": 12,
        "invoiced_amount_due_cents": 98000,
        "mrr_cents": 94800,
        "paid_invoice_count": 10,
        "past_due_customers": 1,
        "payment_failed_invoice_count": 1,
        "plan": "Pro",
        "retained_mrr_cents": 91900,
        "stripe_actual_net_cash_cents": 90200,
        "stripe_actual_total_cents": 98000
      }
    ],
    "retained_mrr_cents": 115800,
    "stripe_actual_net_cash_cents": 114100,
    "stripe_actual_total_cents": 121900
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.