---
title: "Every charge of the organization's cases in this mode, newest first, optionally only one status or the charges created between two days (UTC), with the billing page's totals. Anyone in the organization can read them"
method: GET
path: "/v1/charges"
---

# Every charge of the organization's cases in this mode, newest first, optionally only one status or the charges created between two days (UTC), with the billing page's totals. Anyone in the organization can read them

`GET /v1/charges`

## Request

- Base URL: `https://api.evictionsapi.com`
- URL: `https://api.evictionsapi.com/v1/charges`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Query parameters

- `cursor` string
- `limit` string
- `status` 'due' | 'paid' | 'void' | 'refunded'
- `from` string
- `to` string

## Response `200`

A page of charges, and the totals over all of them. `paymentsEnabled` false: online payment is off, and `checkout` answers 409 `payments_unavailable`.

- object
  - `items` CustomerCharge[], required
    - `id` string, required
    - `caseId` string, required
    - `propertyState` string, required: Two-letter code of the property's state. Empty for a case whose details were erased.
    - `kind` 'platform_fee' | 'court_costs' | 'service_costs' | 'other', required
    - `description` string, required
    - `amountCents` integer, required: US cents.
    - `status` 'due' | 'paid' | 'void' | 'refunded', required
    - `collection` 'checkout' | 'automatic', required: As on `Charge`.
    - `paidAt` string, date-time, nullable, required
    - `receiptUrl` string, uri, nullable, required: As on `Charge`.
    - `createdAt` string, date-time, required
  - `nextCursor` string, nullable, required
  - `paymentsEnabled` boolean, required
  - `totals` ChargeTotals, required: The billing page's totals over all the organization's charges in the mode, whatever the filter, in US cents. Years are UTC calendar years. "Refunded this year" counts charges by the day they were refunded.
    - `dueCount` integer, required
    - `dueCents` integer, required
    - `paidLast30Cents` integer, required
    - `paidThisYearCents` integer, required
    - `refundedThisYearCents` integer, required

## Other responses

- `400`: The request is invalid.
- `401`: The credential is missing or invalid.
- `403`: The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
- `404`: Not found.
- `409`: The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
- `422`: The case did not pass a check.

---

[API](https://skmtc.dev/evictionsapi/apis/evictions-api.md) · [All operations](https://skmtc.dev/evictionsapi/apis/evictions-api/llms.txt) · [OpenAPI document](https://skmtc.dev/evictionsapi/apis/evictions-api/revisions/28459213a1a3?raw)