Billing

List billing finance periods

Returns closed billing totals grouped by period (admin only). limit defaults to 12 and is clamped to 24; plan filters by plan, and exclude_test_accounts drops sandbox accounts. Each period has its period_key, customers, subscription, overage and invoice amounts in cents, paid and remaining amounts, Stripe actuals and mismatch totals.

get/admin/billing/finance/periods

Request

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

Query parameters

limitinteger

Maximum periods to return. Defaults to 12 and clamps to 24.

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 periods

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": [
    {
      "amount_paid_cents": 90200,
      "amount_remaining_cents": 7800,
      "customers": 12,
      "expected_total_amount_cents": 98000,
      "invoice_amount_due_cents": 98000,
      "invoice_count": 12,
      "overage_amount_cents": 3200,
      "paid_invoice_count": 10,
      "payment_failed_invoice_count": 1,
      "period_key": "2026-04",
      "stripe_actual_net_cash_cents": 90200,
      "stripe_actual_total_cents": 98000,
      "subscription_amount_cents": 94800
    }
  ],
  "msg": "OK"
}

Changes

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