---
title: "List billing finance periods"
method: GET
path: "/admin/billing/finance/periods"
tags: ["Billing"]
---

# List billing finance periods

`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`

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.

## Query parameters

- `limit` integer
- `plan` 'Free' | 'Starter' | 'Growth' | 'Pro' | 'Business' | 'Enterprise' | 'Admin'
- `exclude_test_accounts` boolean

## Headers

- `x-api-key` string, required

## Response `200`

Billing finance periods

- BillingBillingFinancePeriodsResponseDoc
  - `code` integer
  - `data` BillingBillingFinancePeriodItemDoc[]
    - `amount_paid_cents` integer
    - `amount_remaining_cents` integer
    - `customers` integer
    - `expected_total_amount_cents` integer
    - `invoice_amount_due_cents` integer
    - `invoice_count` integer
    - `mismatch_invoice_count` integer
    - `mismatch_total_cents` integer
    - `overage_amount_cents` integer
    - `paid_invoice_count` integer
    - `payment_failed_invoice_count` integer
    - `period_key` string
    - `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
    - `subscription_amount_cents` 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/028417aa35bb?raw)