Retrieve Dispute

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.disputes.retrieve({
    id: "id"
});

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/disputes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/disputes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/disputes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/disputes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "acceptable": true,
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": 150,
  "buyer": {
    "email": "marcus@shinetime.example",
    "member_id": "mber_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "user_id": "user_xxxxxxxxxxxxxx",
    "username": "danawhitfield"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "evidence": {
    "access_activity_log": "Vehicle checked in 2026-01-04 09:02, released 2026-01-05 16:40. Signed release on file.",
    "billing_address": "4180 Burnet Rd, Austin, TX 78756, US",
    "cancellation_policy_attachment": {
      "content_type": "image/png",
      "filename": "booking-confirmation-email.png",
      "id": "file_xxxxxxxxxxxxxx",
      "platform": false,
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "cancellation_policy_disclosure": "Shown at checkout and again in the booking confirmation email.",
    "customer_communication_attachment": {
      "content_type": "image/png",
      "filename": "booking-confirmation-email.png",
      "id": "file_xxxxxxxxxxxxxx",
      "platform": false,
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "customer_email_address": "marcus@shinetime.example",
    "customer_name": "Dana Whitfield",
    "documents": [
      {
        "blurhash": "LA6bDXT$E3b:R6i+RibEIWbp%ej1",
        "content_type": "image/png",
        "created_at": "2026-01-01T12:00:00.000Z",
        "document_type": "customer_order_history",
        "duration_seconds": null,
        "filename": "customer-order-history.png",
        "height": 100,
        "id": "file_xxxxxxxxxxxxxx",
        "object": "file",
        "removed_by_moderation": false,
        "size": 1024,
        "upload_status": "ready",
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "visibility": "public",
        "waveform_url": null,
        "width": 100,
        "multipart_chunk_size": 123,
        "multipart_upload_id": "<string>",
        "multipart_upload_urls": [
          {
            "part_number": 1,
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
          }
        ],
        "upload_headers": {},
        "upload_url": "<string>"
      }
    ],
    "notes": "Two-day ceramic coating completed and collected. Before and after photos attached.",
    "product_description": "Two-stage paint correction with a three-year ceramic coating.",
    "refund_policy_attachment": {
      "content_type": "image/png",
      "filename": "booking-confirmation-email.png",
      "id": "file_xxxxxxxxxxxxxx",
      "platform": false,
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "refund_policy_disclosure": "Linked from the booking page and accepted at checkout.",
    "refund_refusal_explanation": "Work was completed and the vehicle collected, so the deposit is non-refundable.",
    "service_date": "2026-01-01",
    "uncategorized_attachment": {
      "content_type": "image/png",
      "filename": "booking-confirmation-email.png",
      "id": "file_xxxxxxxxxxxxxx",
      "platform": false,
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  },
  "evidence_due_at": "2026-01-01T12:00:00.000Z",
  "evidence_editable": true,
  "evidence_locked_reason": "not_contestable",
  "evidence_submitted_at": null,
  "fee": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "fee_charged": true,
  "id": "dspt_xxxxxxxxxxxxxx",
  "inquiry": false,
  "issuer_comments": [
    {
      "received_at": "2026-01-01T12:00:00.000Z",
      "text": "Note: Cardholder states the ceramic coating appointment never took place\nCancellation method: By phone"
    }
  ],
  "line_items": [
    {
      "id": "li_xxxxxxxxxxxxxx",
      "label": "Ceramic Coating Package",
      "product_id": "prod_xxxxxxxxxxxxxx",
      "product_title": "Ceramic Coating Package",
      "quantity": 1,
      "sku": null,
      "subtotal": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "variant_id": "plan_xxxxxxxxxxxxxx",
      "variant_title": "Ceramic Coating — Full Vehicle"
    }
  ],
  "payment": {
    "amount": 249,
    "card_brand": "visa",
    "card_last4": "4242",
    "created_at": "2026-01-01T12:00:00.000Z",
    "currency": "usd",
    "id": "pay_xxxxxxxxxxxxxx",
    "payment_instrument": {
      "card": {
        "brand": "visa",
        "exp_month": 10,
        "exp_year": 2031,
        "issuer_identification_number": "41111111",
        "last4": "4242",
        "network_transaction_id": "016153570198200"
      },
      "display_name": "Visa •••• 4242",
      "icons": {
        "card": {
          "dark": {
            "png_1x": "https://content.whop.com/payment_methods/card/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/card/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/card/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/card/icons/card_dark.svg"
          },
          "light": {
            "png_1x": "https://content.whop.com/payment_methods/card/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/card/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/card/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/card/icons/card_dark.svg"
          }
        },
        "square": {
          "dark": {
            "png_1x": "https://content.whop.com/payment_methods/card/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/card/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/card/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/card/icons/card_dark.svg"
          },
          "light": {
            "png_1x": "https://content.whop.com/payment_methods/card/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/card/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/card/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/card/icons/card_dark.svg"
          }
        }
      },
      "installment_count": null,
      "payment_method_type": "card"
    },
    "payment_method_type": "card",
    "payment_processor": null
  },
  "product_id": "prod_xxxxxxxxxxxxxx",
  "reason": "other",
  "reason_code": "13.1",
  "status": "needs_response",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "variant_id": "plan_xxxxxxxxxxxxxx"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

disputes

{id}

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.disputes.retrieve({
    id: "id"
});

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/disputes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/disputes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/disputes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/disputes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "acceptable": true,
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": 150,
  "buyer": {
    "email": "marcus@shinetime.example",
    "member_id": "mber_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "user_id": "user_xxxxxxxxxxxxxx",
    "username": "danawhitfield"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "evidence": {
    "access_activity_log": "Vehicle checked in 2026-01-04 09:02, released 2026-01-05 16:40. Signed release on file.",
    "billing_address": "4180 Burnet Rd, Austin, TX 78756, US",
    "cancellation_policy_attachment": {
      "content_type": "image/png",
      "filename": "booking-confirmation-email.png",
      "id": "file_xxxxxxxxxxxxxx",
      "platform": false,
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "cancellation_policy_disclosure": "Shown at checkout and again in the booking confirmation email.",
    "customer_communication_attachment": {
      "content_type": "image/png",
      "filename": "booking-confirmation-email.png",
      "id": "file_xxxxxxxxxxxxxx",
      "platform": false,
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "customer_email_address": "marcus@shinetime.example",
    "customer_name": "Dana Whitfield",
    "documents": [
      {
        "blurhash": "LA6bDXT$E3b:R6i+RibEIWbp%ej1",
        "content_type": "image/png",
        "created_at": "2026-01-01T12:00:00.000Z",
        "document_type": "customer_order_history",
        "duration_seconds": null,
        "filename": "customer-order-history.png",
        "height": 100,
        "id": "file_xxxxxxxxxxxxxx",
        "object": "file",
        "removed_by_moderation": false,
        "size": 1024,
        "upload_status": "ready",
        "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "visibility": "public",
        "waveform_url": null,
        "width": 100,
        "multipart_chunk_size": 123,
        "multipart_upload_id": "<string>",
        "multipart_upload_urls": [
          {
            "part_number": 1,
            "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
          }
        ],
        "upload_headers": {},
        "upload_url": "<string>"
      }
    ],
    "notes": "Two-day ceramic coating completed and collected. Before and after photos attached.",
    "product_description": "Two-stage paint correction with a three-year ceramic coating.",
    "refund_policy_attachment": {
      "content_type": "image/png",
      "filename": "booking-confirmation-email.png",
      "id": "file_xxxxxxxxxxxxxx",
      "platform": false,
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "refund_policy_disclosure": "Linked from the booking page and accepted at checkout.",
    "refund_refusal_explanation": "Work was completed and the vehicle collected, so the deposit is non-refundable.",
    "service_date": "2026-01-01",
    "uncategorized_attachment": {
      "content_type": "image/png",
      "filename": "booking-confirmation-email.png",
      "id": "file_xxxxxxxxxxxxxx",
      "platform": false,
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  },
  "evidence_due_at": "2026-01-01T12:00:00.000Z",
  "evidence_editable": true,
  "evidence_locked_reason": "not_contestable",
  "evidence_submitted_at": null,
  "fee": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "fee_charged": true,
  "id": "dspt_xxxxxxxxxxxxxx",
  "inquiry": false,
  "issuer_comments": [
    {
      "received_at": "2026-01-01T12:00:00.000Z",
      "text": "Note: Cardholder states the ceramic coating appointment never took place\nCancellation method: By phone"
    }
  ],
  "line_items": [
    {
      "id": "li_xxxxxxxxxxxxxx",
      "label": "Ceramic Coating Package",
      "product_id": "prod_xxxxxxxxxxxxxx",
      "product_title": "Ceramic Coating Package",
      "quantity": 1,
      "sku": null,
      "subtotal": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "variant_id": "plan_xxxxxxxxxxxxxx",
      "variant_title": "Ceramic Coating — Full Vehicle"
    }
  ],
  "payment": {
    "amount": 249,
    "card_brand": "visa",
    "card_last4": "4242",
    "created_at": "2026-01-01T12:00:00.000Z",
    "currency": "usd",
    "id": "pay_xxxxxxxxxxxxxx",
    "payment_instrument": {
      "card": {
        "brand": "visa",
        "exp_month": 10,
        "exp_year": 2031,
        "issuer_identification_number": "41111111",
        "last4": "4242",
        "network_transaction_id": "016153570198200"
      },
      "display_name": "Visa •••• 4242",
      "icons": {
        "card": {
          "dark": {
            "png_1x": "https://content.whop.com/payment_methods/card/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/card/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/card/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/card/icons/card_dark.svg"
          },
          "light": {
            "png_1x": "https://content.whop.com/payment_methods/card/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/card/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/card/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/card/icons/card_dark.svg"
          }
        },
        "square": {
          "dark": {
            "png_1x": "https://content.whop.com/payment_methods/card/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/card/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/card/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/card/icons/card_dark.svg"
          },
          "light": {
            "png_1x": "https://content.whop.com/payment_methods/card/icons/card_dark_30.png",
            "png_2x": "https://content.whop.com/payment_methods/card/icons/card_dark_60.png",
            "png_4x": "https://content.whop.com/payment_methods/card/icons/card_dark_120.png",
            "svg": "https://content.whop.com/payment_methods/card/icons/card_dark.svg"
          }
        }
      },
      "installment_count": null,
      "payment_method_type": "card"
    },
    "payment_method_type": "card",
    "payment_processor": null
  },
  "product_id": "prod_xxxxxxxxxxxxxx",
  "reason": "other",
  "reason_code": "13.1",
  "status": "needs_response",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "variant_id": "plan_xxxxxxxxxxxxxx"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-11-02-1"

Path Parameters

string

required

The dispute ID (dspt_ tag).

Response

dispute returned

acceptable

boolean

required

Whether the dispute can be conceded to the customer with POST /disputes/{id}/accept. True only for a chargeback still awaiting a response, before evidence_due_at, whose payment processor supports accepting disputes. Inquiries are never acceptable.

Example:

true

account_id

string | null

required

The account the dispute was filed against, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

amount

number

required

The disputed amount, in whole units of currency.

Example:

150

buyer

object

required

The customer who filed the dispute.

Show child attributes

created_at

string

required

When the dispute was opened, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

currency

string

required

Three-letter ISO currency code of the disputed amount.

Example:

"usd"

evidence

object

required

The evidence packet sent to the processor to contest the dispute.

Show child attributes

evidence_due_at

string | null

required

The deadline to submit evidence, as an ISO 8601 timestamp. null when the network already auto-resolved the dispute (Visa RDR) with no evidence round, or when the processor hasn't reported a deadline for this dispute.

Example:

"2026-01-01T12:00:00.000Z"

evidence_editable

boolean

required

Whether evidence can still be changed and submitted.

Example:

true

evidence_locked_reason

enum<string> | null

required

Why evidence can no longer be edited. null while evidence_editable is true.

Available options:

submitted,

response_window_closed,

not_contestable,

null

Example:

"not_contestable"

evidence_submitted_at

string | null

required

When the evidence was submitted to the processor, as an ISO 8601 timestamp.

Example:

null

fee

object | null

required

The dispute fee charged to the account, in the currency it was collected in. null when fee_charged is false.

Show child attributes

fee_charged

boolean

required

Whether Whop charged the account a dispute fee for this one. false when the payment was fully refunded before the dispute was opened, for a Visa RDR resolution, and for an inquiry.

Example:

true

string

required

Dispute ID, prefixed dspt_.

Example:

"dspt_xxxxxxxxxxxxxx"

inquiry

boolean

required

Whether this is a pre-dispute inquiry rather than a formal chargeback. Inquiries follow the same lifecycle but move no funds unless one escalates.

Example:

false

issuer_comments

object[]

required

Show child attributes

line_items

object[]

required

Show child attributes

payment

object

required

The payment being disputed.

Show child attributes

product_id

string | null

required

The product the disputed payment was for, prefixed prod_.

Example:

"prod_xxxxxxxxxxxxxx"

reason

enum<string>

required

Why the customer says they are disputing, normalized across processors and card networks. other covers a processor reason Whop has not categorized yet.

Available options:

fraudulent,

unrecognized,

declined_authorization,

product_not_received,

product_unacceptable,

subscription_canceled,

credit_not_processed,

duplicate,

processing_error,

documentation_request,

bank_cannot_process,

other

Example:

"other"

reason_code

string | null

required

The raw card-network or processor reason code, such as 10.4. Informational only — reason is not derived from it.

Example:

"13.1"

status

enum<string>

required

Where the dispute stands. needs_response is awaiting evidence, under_review is with the processor, won returned the funds to the seller, lost returned them to the customer, and prevented means the customer was refunded before any ruling, so it settles like lost. The warning_ statuses are the same stages for an inquiry, which moves no funds. A dispute past its evidence_due_at reports under_review — the window to respond has closed.

Available options:

needs_response,

warning_needs_response,

under_review,

warning_under_review,

won,

lost,

prevented,

warning_closed

Example:

"needs_response"

updated_at

string

required

When the dispute was last changed, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

variant_id

string | null

required

The variant the disputed payment was made on, prefixed plan_.

Example:

"plan_xxxxxxxxxxxxxx"

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Authorizations

Headers

Path Parameters

Response