---
title: "Retrieves the collection of Charge resources."
method: GET
path: "/charges"
tags: ["Charge"]
---

# Retrieves the collection of Charge resources.

`GET /charges`

Retrieves the collection of Charge resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Charge collection

- Charge[]
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — Unique identifier for a charge
  - `amount` integer — The amount charged
  - `amountRefunded` integer, nullable — The amount refunded
  - `applicationId` string, nullable — ID of the application that created the charge
  - `applicationFeeAmount` integer, nullable — The application fee for the charge
  - `balanceTransactionId` string, nullable — ID of the balance transaction that describes the impact of the charge on the account balance
  - `billingAddress` string, nullable — The billing address for the payment
  - `billingEmail` string, nullable — The email address associated with the charge
  - `billingName` string, nullable — The full name of the customer the charge is for
  - `billingPhone` string, nullable — The phone number of the customer the charge is for
  - `created` string, date-time, nullable — The date and time the charge was created
  - `currency` string — The currency the charge was made in
  - `customerId` string, nullable — The ID associated with the customer in which the charge is for
  - `chargeDescription` string, nullable — A description of the charge
  - `invoiceId` string, nullable — The ID of the invoice this charge is for
  - `receiptNumber` string, nullable — The transaction number that appears on email receipts sent for this charge
  - `refunded` string, nullable — Whether the charge has been fully refunded
  - `status` string, nullable — The status of the charge e.g. "succeeded" e.g. "pending" e.g. "failed"
  - `shippingAddress` string, nullable — The shipping address associated with the charge
  - `shippingName` string, nullable — Recipient name
  - `shippingPhone` string, nullable — Recipient phone number
  - `shippingTrackingNumber` string, nullable — The tracking number for a physical product, obtained from the delivery service

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)