---
title: "Retrieve Payment Summary"
method: GET
path: "/payments/summary"
tags: ["Payments"]
---

# Retrieve Payment Summary

`GET /payments/summary`

## Request

- Base URL: `https://api.whop.com/api/v1`
- URL: `https://api.whop.com/api/v1/payments/summary`
- Auth: HTTP bearer

Totals up the same payments the list returns, so you can build status tabs and filter options without paging through them. Takes the same filters as List Payments.

## Query parameters

- `groups` string[]
- `account_id` string
- `statuses` string[]
- `substatuses` string[]
- `billing_reasons` string[]
- `currencies` string[]
- `plan_ids` string[]
- `product_ids` string[]
- `payment_methods` string[]
- `tracking_states` string[]
- `created_after` string, date-time
- `created_before` string, date-time
- `query` string
- `include_connected_accounts` boolean

## Response `200`

summary returned

- object
  - `groups` object, required: One entry per requested breakdown, keyed by the field it groups on. A field you did not ask for is absent.
    - `currency` object: How many of the matching payments are in each currency, keyed by three-letter code. Only currencies with at least one payment are present.
    - `substatus` object: How many of the matching payments are in each substatus. Every substatus is present, including those with a count of zero.
      - `auto_refunded` integer, required
      - `blocked` integer, required
      - `canceled` integer, required
      - `dispute_closed` integer, required
      - `dispute_lost` integer, required
      - `dispute_needs_response` integer, required
      - `dispute_under_review` integer, required
      - `dispute_warning` integer, required
      - `dispute_warning_closed` integer, required
      - `dispute_warning_needs_response` integer, required
      - `dispute_warning_under_review` integer, required
      - `dispute_won` integer, required
      - `drafted` integer, required
      - `failed` integer, required
      - `incomplete` integer, required
      - `partially_refunded` integer, required
      - `past_due` integer, required
      - `pending` integer, required
      - `price_too_low` integer, required
      - `refunded` integer, required
      - `requires_capture` integer, required
      - `resolution_lost` integer, required
      - `resolution_needs_response` integer, required
      - `resolution_under_review` integer, required
      - `resolution_won` integer, required
      - `succeeded` integer, required
      - `uncollectible` integer, required
      - `unresolved` integer, required
  - `total` integer, required: How many payments match the filters.

## Changes

> 124 revisions in range; 1 not diffed.

- **2026-10-21** `513e62e6d7e0`: 1 info
  - added the new optional `query` request parameter `include_connected_accounts`
- **2026-10-20** `27649ab2b67a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/whop/apis/whop-api/changes/payments/summary/get.md)

---

[API](https://skmtc.dev/whop/apis/whop-api.md) · [All operations](https://skmtc.dev/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whop/apis/whop-api/revisions/99c00dbdc4d0?raw)