Disputes

Retrieve Dispute Summary

Totals up the same disputes the list returns, so you can build status tabs and totals without paging through them.

get/disputes/summary

Query parameters

groupsstring[]

Which breakdowns to return, keyed by these names under groups. Repeat the parameter to ask for several; omit it for all of them.

[
  "status"
]
account_idstring

Only disputes filed against this account (biz_ tag). Omit it to cover every account you can read.

statusstring[]

Only disputes in these statuses. Repeat the parameter to pass several. A needs_response dispute whose evidence deadline has passed reports and filters as under_review instead.

[
  "needs_response"
]
currencystring

Only disputes in this three-letter ISO currency.

created_beforestring

Only disputes opened before this ISO 8601 timestamp.

created_afterstring

Only disputes opened after this ISO 8601 timestamp.

Headers

Api-Version-Datestring
Example:2026-09-25

Pins the request to a dated API version.

Response

summary returned

totalinteger required

How many disputes match the filters.

Example response

{
  "groups": {
    "currency": {
      "usd": 1
    },
    "status": {
      "needs_response": 1
    }
  },
  "total": 1
}

Changes

Changed in 3 of the 74 revisions of this API.9

    • ○

      added the enum value warning_closed to the property items/ of the query request parameter status

      request-parameter-property-enum-value-added

    • ○

      added the enum value warning_needs_response to the property items/ of the query request parameter status

      request-parameter-property-enum-value-added

    • ○

      added the enum value warning_under_review to the property items/ of the query request parameter status

      request-parameter-property-enum-value-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.