---
title: "Get current user's billing period statement"
method: GET
path: "/billing/me/periods/{period_key}/statement"
tags: ["Billing"]
---

# Get current user's billing period statement

`GET /billing/me/periods/{period_key}/statement`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/billing/me/periods/{period_key}/statement`
- Auth: API key in header `x-api-key`

Returns a customer-safe JSON statement for one billing period, combining the ledger, endpoint breakdown, optional billing events, and Stripe invoice evidence. Closed periods normally return a pre-frozen snapshot created during period close; historical closed periods without a snapshot are lazily frozen on read. Repair errors and raw webhook audit details are not exposed.

## Path parameters

- `period_key` string, required

## Query parameters

- `include_events` boolean
- `event_limit` integer

## Headers

- `x-api-key` string, required

## Response `200`

Billing period statement

- BillingBillingPeriodStatementResponseDoc
  - `code` integer
  - `data` BillingBillingPeriodStatementDoc
    - `accounts_receivable` BillingBillingStatementAccountsReceivableDoc
      - `amount_due_cents` integer
      - `amount_paid_cents` integer
      - `amount_remaining_cents` integer
      - `due_date` string
      - `effective_due_date` string
      - `finalized_at` string
      - `invoice_status` string
      - `paid_at` string
      - `payment_failed_at` string
    - `adjustment_events` BillingBillingStatementAdjustmentEvidenceDoc[]
      - `amount_cents` integer
      - `currency` string
      - `error` string
      - `event_created` string
      - `event_id` string
      - `event_type` string
      - `kind` string
      - `match_status` string
      - `processed_at` string
      - `reconciliation_status` string
      - `repair_attempts` integer
      - `repair_last_error` string
      - `repair_status` string
      - `resource_id` string
      - `resource_status` string
      - `stripe_invoice_id` string
    - `endpoint_breakdown` BillingBillingEndpointLedgerDoc[]
      - `charged_requests` integer
      - `credits` integer
      - `endpoint` string
      - `failed_requests` integer
      - `non_billable_requests` integer
      - `overage` integer
      - `requests` integer
    - `events` BillingBillingStatementEventItemDoc[]
      - `billable` boolean
      - `created_at` string
      - `credit_cost` integer
      - `endpoint` string
      - `event_status` string
      - `non_billable_reason` string
      - `request_id` string
      - `status_code` integer
    - `expected` BillingBillingStatementExpectedRevenueDoc
      - `credits_used` integer
      - `currency` string
      - `expected_subscription_amount_cents` integer
      - `expected_total_amount_cents` integer
      - `included_credits` integer
      - `overage_amount_cents` integer
      - `overage_credits` integer
      - `overage_price_per_1000` number
      - `pricing_source` string
      - `subscription_price_cents` integer
    - `generated_at` string
    - `invoice` BillingBillingStatementInvoiceEvidenceDoc
      - `amount_due_cents` integer
      - `amount_paid_cents` integer
      - `amount_remaining_cents` integer
      - `currency` string
      - `due_date` string
      - `effective_due_date` string
      - `finalized_at` string
      - `hosted_invoice_url` string
      - `invoice_pdf` string
      - `line_items` BillingStripeInvoiceLineItemDoc[]
        - `amount_cents` integer
        - `category` string
        - `currency` string
        - `description` string
        - `line_id` string
        - `period_end` string
        - `period_start` string
        - `proration` boolean
        - `source_ref` string
        - `type` string
      - `mismatch_flags` string[]
      - `mismatch_total_cents` integer
      - `paid_at` string
      - `period_end` string
      - `period_start` string
      - `reconciliation_status` string
      - `repair_attempts` integer
      - `repair_error` string
      - `repair_status` string
      - `stripe_invoice_id` string
      - `stripe_invoice_number` string
      - `stripe_invoice_status` string
    - `invoice_events` BillingBillingStatementInvoiceEventEvidenceDoc[]
      - `error` string
      - `event_created` string
      - `event_id` string
      - `event_type` string
      - `match_status` string
      - `processed_at` string
      - `reconciliation_status` string
      - `repair_attempts` integer
      - `repair_last_error` string
      - `repair_status` string
      - `stripe_invoice_id` string
      - `stripe_invoice_status` string
    - `mismatch` BillingBillingStatementMismatchDoc
      - `mismatch_flags` string[]
      - `mismatch_total_cents` integer
    - `period` BillingBillingStatementPeriodDoc
      - `closed_at` string
      - `period_end` string
      - `period_key` string
      - `period_start` string
      - `status` string
    - `plan` string
    - `repair` BillingBillingStatementRepairDoc
      - `repair_attempts` integer
      - `repair_last_attempt_at` string
      - `repair_last_error` string
      - `repair_status` string
      - `stripe_sync_attempts` integer
      - `stripe_sync_error` string
      - `stripe_sync_status` string
      - `stripe_synced_at` string
    - `snapshot` BillingBillingStatementSnapshotMetadataDoc
      - `canonical_json_sha256` string
      - `frozen_at` string
      - `generated_at` string
      - `revision` integer
      - `snapshot_status` string
      - `source_ledger_updated_at` string
      - `source_snapshot_updated_at` string
      - `statement_id` string
      - `statement_version` string
    - `stripe_actual` BillingBillingStatementStripeActualDoc
      - `amount_due_cents` integer
      - `amount_paid_cents` integer
      - `amount_remaining_cents` integer
      - `credit_note_cents` integer
      - `currency` string
      - `discount_cents` integer
      - `net_cash_cents` integer
      - `one_time_cents` integer
      - `overage_cents` integer
      - `proration_cents` integer
      - `refund_cents` integer
      - `snapshot_updated_at` string
      - `subscription_cents` integer
      - `tax_cents` integer
      - `total_cents` integer
    - `user` BillingBillingStatementUserDoc
      - `email` string
      - `plan` string
      - `stripe_customer_id` string
      - `user_id` string
      - `username` string
  - `msg` string

## Other responses

- `400`: Invalid period key or query parameters
- `401`: Authentication 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)