> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # List disputes > Returns a paginated list of disputes for a company, with optional filtering by creation date. A dispute represents a chargeback or inquiry filed by a customer against a payment. Required permissions: - `payment:dispute:read` - `plan:basic:read` - `access_pass:basic:read` - `company:basic:read` - `payment:basic:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /disputes openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /disputes: get: tags: - Disputes summary: List disputes description: >- Returns a paginated list of disputes for a company, with optional filtering by creation date. A dispute represents a chargeback or inquiry filed by a customer against a payment. Required permissions: - `payment:dispute:read` - `plan:basic:read` - `access_pass:basic:read` - `company:basic:read` - `payment:basic:read` operationId: listDispute parameters: - explode: true in: query name: after required: false schema: description: >- Returns the elements in the list that come after the specified cursor. type: string style: form - explode: true in: query name: before required: false schema: description: >- Returns the elements in the list that come before the specified cursor. type: string style: form - explode: true in: query name: first required: false schema: description: Returns the first _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: last required: false schema: description: Returns the last _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: company_id required: true schema: description: The unique identifier of the company to list disputes for. example: biz_xxxxxxxxxxxxxx type: string style: form - explode: true in: query name: direction required: false schema: $ref: '#/components/schemas/Direction' description: >- The sort direction for ordering results, either ascending or descending. style: form - explode: true in: query name: created_before required: false schema: description: Only return disputes created before this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: string style: form - explode: true in: query name: created_after required: false schema: description: Only return disputes created after this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: string style: form responses: '200': content: application/json: schema: description: The connection type for Dispute. properties: data: description: A list of nodes. items: $ref: '#/components/schemas/DisputeListItem' type: array page_info: $ref: '#/components/schemas/PageInfo' description: Information to aid in pagination. required: - data - page_info type: object description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - payment:dispute:read - plan:basic:read - access_pass:basic:read - company:basic:read - payment:basic:read x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const dispute of client.disputes.list()) { console.log(dispute.id); } components: schemas: Direction: description: The direction of the sort. enum: - asc - desc type: string DisputeListItem: description: >- A dispute is a chargeback or payment challenge filed against a company, including evidence and response status. properties: amount: description: >- The disputed amount in the specified currency, formatted as a decimal. example: 6.9 type: number company: description: The company that the dispute was filed against. properties: id: description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx type: string title: description: The written name of the company. type: string required: - id - title type: - object - 'null' created_at: description: The datetime the dispute was created. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' currency: $ref: '#/components/schemas/Currencies' description: The three-letter ISO currency code for the disputed amount. editable: description: Whether the dispute evidence can still be edited and submitted. type: - boolean - 'null' id: description: The unique identifier for the dispute. example: dspt_xxxxxxxxxxxxx type: string needs_response_by: description: >- The deadline by which dispute evidence must be submitted. Null if no response deadline is set. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' payment: description: The original payment that was disputed. properties: id: description: The unique identifier for the payment. example: pay_xxxxxxxxxxxxxx type: string payment_instrument: description: >- The instrument this payment was made with, shaped for display: the method type, a buyer-facing name, the standard icon set, and the card facts when it was a card. Null when the receipt names no payment method. properties: display_name: description: >- Buyer-facing instrument name — "Visa •••• 4242" when the card surfaced, else the method's own name ("Klarna"). type: string icons: description: >- The standard icon set: square and card shapes, each in light and dark colorways. properties: square: description: The square tile (32x32). properties: dark: description: The colorway for dark surfaces. properties: svg: description: >- The vector file. Prefer this everywhere SVG renders. type: string required: - svg type: object light: description: The colorway for light surfaces. properties: svg: description: >- The vector file. Prefer this everywhere SVG renders. type: string required: - svg type: object required: - light - dark type: object required: - square type: object installment_count: description: >- Installment methods only: how many payments the charge splits into. Data, not copy — compose and translate the label client-side. example: 42 type: - integer - 'null' payment_method_type: description: >- The payment method type identifier, e.g. `card`, `klarna`, `apple_pay`. type: string required: - payment_method_type - display_name - installment_count - icons type: - object - 'null' required: - id - payment_instrument type: - object - 'null' plan: description: >- The plan associated with the disputed payment. Null if the dispute is not linked to a specific plan. properties: id: description: The unique identifier for the plan. example: plan_xxxxxxxxxxxxx type: string required: - id type: - object - 'null' product: description: >- The product associated with the disputed payment. Null if the dispute is not linked to a specific product. properties: id: description: The unique identifier for the product. example: prod_xxxxxxxxxxxxx type: string title: description: >- The display name of the product shown to customers on the product page and in search results. example: Pickaxe Analytics type: string required: - id - title type: - object - 'null' reason: description: A human-readable reason for the dispute. example: Product Not Received type: - string - 'null' reason_code: description: >- The card network reason code for the dispute. Null when the payment processor did not provide one. example: '10.4' type: - string - 'null' status: $ref: '#/components/schemas/DisputeStatuses' description: >- The current status of the dispute lifecycle, such as needs_response, under_review, won, or lost. visa_rdr: description: >- Whether the dispute was automatically resolved through Visa Rapid Dispute Resolution (RDR). type: boolean required: - id - amount - currency - status - editable - created_at - visa_rdr - needs_response_by - reason - reason_code - plan - product - company - payment type: object PageInfo: description: Information about pagination in a connection. properties: end_cursor: description: When paginating forwards, the cursor to continue. type: - string - 'null' has_next_page: description: When paginating forwards, are there more items? type: boolean has_previous_page: description: When paginating backwards, are there more items? type: boolean start_cursor: description: When paginating backwards, the cursor to continue. type: - string - 'null' required: - end_cursor - start_cursor - has_next_page - has_previous_page type: object Currencies: description: The available currencies on the platform enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt - awg - whop_usd - xau type: string DisputeStatuses: description: The possible statuses of a dispute enum: - warning_needs_response - warning_under_review - warning_closed - needs_response - under_review - won - lost - closed - other type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````