Skip to main content
GET
/
disputes
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: 'My API Key',
});

const dispute = await client.disputes.retrieve('dspt_xxxxxxxxxxxxx');

console.log(dispute.id);
{
  "id": "dspt_xxxxxxxxxxxxx",
  "amount": 6.9,
  "currency": "usd",
  "status": "warning_needs_response",
  "editable": true,
  "created_at": "2023-12-01T05:00:00.401Z",
  "visa_rdr": true,
  "needs_response_by": "2023-12-01T05:00:00.401Z",
  "reason": "<string>",
  "plan": {
    "id": "plan_xxxxxxxxxxxxx"
  },
  "product": {
    "id": "prod_xxxxxxxxxxxxx",
    "title": "<string>"
  },
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "<string>"
  },
  "payment": {
    "id": "pay_xxxxxxxxxxxxxx",
    "total": 6.9,
    "subtotal": 6.9,
    "usd_total": 6.9,
    "currency": "usd",
    "created_at": "2023-12-01T05:00:00.401Z",
    "paid_at": "2023-12-01T05:00:00.401Z",
    "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
    "payment_method_type": "acss_debit",
    "billing_reason": "subscription_create",
    "card_brand": "mastercard",
    "card_last4": "<string>",
    "user": {
      "id": "user_xxxxxxxxxxxxx",
      "name": "<string>",
      "username": "<string>",
      "email": "<string>"
    },
    "member": {
      "id": "<string>",
      "phone": "<string>"
    },
    "membership": {
      "id": "mem_xxxxxxxxxxxxxx",
      "status": "trialing"
    }
  },
  "access_activity_log": "<string>",
  "billing_address": "<string>",
  "cancellation_policy_disclosure": "<string>",
  "customer_email_address": "<string>",
  "customer_name": "<string>",
  "notes": "<string>",
  "product_description": "<string>",
  "refund_policy_disclosure": "<string>",
  "refund_refusal_explanation": "<string>",
  "service_date": "<string>",
  "cancellation_policy_attachment": {
    "id": "<string>",
    "filename": "<string>",
    "content_type": "<string>",
    "url": "<string>"
  },
  "customer_communication_attachment": {
    "id": "<string>",
    "filename": "<string>",
    "content_type": "<string>",
    "url": "<string>"
  },
  "refund_policy_attachment": {
    "id": "<string>",
    "filename": "<string>",
    "content_type": "<string>",
    "url": "<string>"
  },
  "uncategorized_attachment": {
    "id": "<string>",
    "filename": "<string>",
    "content_type": "<string>",
    "url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

​
id
string
required

The ID of the dispute

Example:

"dspt_xxxxxxxxxxxxx"

Response

A successful response

An object representing a dispute against a company.

​
id
string
required

The internal ID of the dispute.

Example:

"dspt_xxxxxxxxxxxxx"

​
amount
number
required

The amount of the dispute (formatted).

Example:

6.9

​
currency
enum<string>
required

The currency of the dispute.

Available options:
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
​
status
enum<string>
required

The status of the dispute (mimics stripe's dispute status).

Available options:
warning_needs_response,
warning_under_review,
warning_closed,
needs_response,
under_review,
won,
lost,
closed,
other
​
editable
boolean | null
required

Whether or not the dispute data can be edited.

​
created_at
string<date-time> | null
required

When it was made.

Example:

"2023-12-01T05:00:00.401Z"

​
visa_rdr
boolean
required

Whether or not the dispute is a Visa Rapid Dispute Resolution.

​
needs_response_by
string<date-time> | null
required

The last date the dispute is allow to be submitted by.

Example:

"2023-12-01T05:00:00.401Z"

​
reason
string | null
required

The reason for the dispute

​
plan
object | null
required

The plan that got disputed

​
product
object | null
required

The product that got disputed

​
company
object | null
required

The company the dispute is against.

​
payment
object | null
required

The payment that got disputed

​
access_activity_log
string | null
required

An IP access log for the user from Whop.

​
billing_address
string | null
required

The billing address of the user from their payment details.

​
cancellation_policy_disclosure
string | null
required

A cancellation policy disclosure from the company.

​
customer_email_address
string | null
required

The email of the customer from their payment details. This is submitted in the evidence packet to the payment processor. You can change it before submitting the dispute.

​
customer_name
string | null
required

The name of the customer from their payment details. This is submitted in the evidence packet to the payment processor. You can change it before submitting the dispute.

​
notes
string | null
required

Additional notes the company chooses to submit regarding the dispute.

​
product_description
string | null
required

The description of the product from the company.

​
refund_policy_disclosure
string | null
required

A refund policy disclosure from the company.

​
refund_refusal_explanation
string | null
required

A description on why the refund is being refused by the company.

​
service_date
string | null
required

When the product was delivered by the company.

​
cancellation_policy_attachment
object | null
required

The cancellation policy for this dispute

​
customer_communication_attachment
object | null
required

The customer communication for this dispute

​
refund_policy_attachment
object | null
required

The refund policy for this dispute

​
uncategorized_attachment
object | null
required

An attachment that did not fit into the other categories