---
title: "Queries billing periods accessible to the current customer."
method: GET
path: "/billing-periods"
tags: ["Billing"]
---

# Queries billing periods accessible to the current customer.

`GET /billing-periods`

The has_billables filter selects periods by whether they have anything to invoice —
 billable response cost, a manual charge, or an external-service charge. It is not applied
 unless requested.

## Query parameters

- `page` integer
- `page_size` integer
- `sort` string[]
- `status` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `organization_id` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `start_date` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `end_date` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `has_billables` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `net_invoiceable_amount` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `settled_at` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `logic` 'and' | 'or'

## Response `200`

OK

- QueryBillingPeriodsEndpointPagedResultOfOutput
  - `total` integer, required
  - `page` integer, required
  - `pageSize` integer, required
  - `items` QueryBillingPeriodsEndpointOutput[], required
    - `id` string, required — The billing period ID.
    - `organizationId` string, required — The organization the billing period belongs to.
    - `startDate` string, date-time, required — The start date of the billing period.
    - `endDate` string, date-time, required — The end date of the billing period.
    - `status` 'Open' | 'Invoiced' | 'Void' | 'Reconciling' | 'PendingReview' | 'Closed', required
    - `netInvoiceableAmount` number, double, nullable — What an invoice for this period would charge, as of the last settlement. Null until the period has been settled.
    - `voucherCoverage` number, double, nullable — How much of the period's billable usage vouchers absorbed at the last settlement.
    - `settlementCurrency` string, nullable — The currency the settlement amounts are denominated in.
    - `settledAt` string, date-time, nullable — When the period was last settled.
    - `settlementStale` boolean, required — Whether a billing input changed after the settlement amounts were computed.
    - `createdAt` string, date-time, required — The date the billing period was created.
  - `totalPages` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Forbidden

---

[API](https://skmtc.net/rapidata/apis/rapidata-api.md) · [All operations](https://skmtc.net/rapidata/apis/rapidata-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapidata/rapidata-api/revisions/fdb89a6eb2fb/schema)