---
title: "List a user's billing period ledgers"
method: GET
path: "/admin/billing/users/{id}/periods"
tags: ["Billing"]
---

# List a user's billing period ledgers

`GET /admin/billing/users/{id}/periods`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/admin/billing/users/{id}/periods`
- Auth: API key in header `x-api-key`

Returns recent billing period ledgers for one user (admin only), identified by `id`. `limit` defaults to 12 and is clamped to 24. Each ledger has `period_key`, `plan`, usage and overage figures, expected amounts, Stripe actual amounts, `endpoint_breakdown` and invoice details such as `stripe_invoice_id`.

## Path parameters

- `id` string, required

## Query parameters

- `limit` integer

## Headers

- `x-api-key` string, required

## Response `200`

Billing period ledgers

- BillingBillingPeriodLedgersResponseDoc
  - `code` integer
  - `data` BillingBillingPeriodLedgerDoc[]
    - `charged_requests` integer
    - `closed_at` string
    - `credits_used` integer
    - `currency` string
    - `endpoint_breakdown` BillingBillingEndpointLedgerDoc[]
      - `charged_requests` integer
      - `credits` integer
      - `endpoint` string
      - `failed_requests` integer
      - `non_billable_requests` integer
      - `overage` integer
      - `requests` integer
    - `expected_subscription_amount_cents` integer
    - `expected_total_amount_cents` integer
    - `failed_requests` integer
    - `generated_at` string
    - `included_credits` integer
    - `mismatch_flags` string[]
    - `mismatch_total_cents` integer
    - `non_billable_requests` integer
    - `overage_amount_cents` integer
    - `overage_credits` integer
    - `overage_price_per_1000` number
    - `period_end` string
    - `period_key` string
    - `period_start` string
    - `plan` string
    - `pricing_source` string
    - `status` string
    - `stripe_actual_amount_due_cents` integer
    - `stripe_actual_amount_paid_cents` integer
    - `stripe_actual_amount_remaining_cents` integer
    - `stripe_actual_credit_note_cents` integer
    - `stripe_actual_discount_cents` integer
    - `stripe_actual_net_cash_cents` integer
    - `stripe_actual_one_time_cents` integer
    - `stripe_actual_overage_cents` integer
    - `stripe_actual_proration_cents` integer
    - `stripe_actual_refund_cents` integer
    - `stripe_actual_subscription_cents` integer
    - `stripe_actual_tax_cents` integer
    - `stripe_actual_total_cents` integer
    - `stripe_customer_id` string
    - `stripe_invoice_amount_due` integer
    - `stripe_invoice_amount_paid` integer
    - `stripe_invoice_amount_remaining` integer
    - `stripe_invoice_currency` string
    - `stripe_invoice_due_date` string
    - `stripe_invoice_effective_due_date` string
    - `stripe_invoice_finalized_at` string
    - `stripe_invoice_hosted_url` string
    - `stripe_invoice_id` string
    - `stripe_invoice_last_event_created` string
    - `stripe_invoice_last_event_id` string
    - `stripe_invoice_number` string
    - `stripe_invoice_paid_at` string
    - `stripe_invoice_payment_failed_at` string
    - `stripe_invoice_pdf` string
    - `stripe_invoice_period_end` string
    - `stripe_invoice_period_start` string
    - `stripe_invoice_reconciliation_error` string
    - `stripe_invoice_reconciliation_status` string
    - `stripe_invoice_status` string
    - `stripe_meter_event_identifier` string
    - `stripe_meter_event_name` string
    - `stripe_snapshot_updated_at` string
    - `stripe_sync_attempts` integer
    - `stripe_sync_error` string
    - `stripe_sync_first_attempt_at` string
    - `stripe_sync_last_attempt_at` string
    - `stripe_sync_status` string
    - `stripe_synced_at` string
    - `subscription_price_cents` integer
    - `updated_at` string
    - `user_id` string
  - `msg` string

## Other responses

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