List disputes

JavaScript

import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const disputeListResponse of client.disputes.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(disputeListResponse.id);
}

{
  "data": [
    {
      "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"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

disputes

JavaScript

import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const disputeListResponse of client.disputes.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(disputeListResponse.id);
}

{
  "data": [
    {
      "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"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

after

string | null

Returns the elements in the list that come after the specified cursor.

before

string | null

Returns the elements in the list that come before the specified cursor.

first

integer | null

Returns the first n elements from the list.

Example:

42

last

integer | null

Returns the last n elements from the list.

Example:

42

company_id

string

required

The ID of the company to list disputes for

Example:

"biz_xxxxxxxxxxxxxx"

direction

enum<string> | null

The direction to sort the disputes by

Available options:

asc,

desc

created_before

string<date-time> | null

The maximum creation date to filter by

Example:

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

created_after

string<date-time> | null

The minimum creation date to filter by

Example:

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

Response

A successful response

The connection type for Dispute.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The internal ID of the dispute.

Example:

"dspt_xxxxxxxxxxxxx"

data.amount

number

required

The amount of the dispute (formatted).

Example:

6.9

data.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,

cny

data.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

data.editable

boolean | null

required

Whether or not the dispute data can be edited.

data.created_at

string<date-time> | null

required

When it was made.

Example:

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

data.visa_rdr

boolean

required

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

data.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"

data.reason

string | null

required

The reason for the dispute

data.plan

object

required

The plan that got disputed

Show child attributes

data.plan.id

string

required

The internal ID of the plan.

Example:

"plan_xxxxxxxxxxxxx"

data.product

object

required

The product that got disputed

Show child attributes

data.product.id

string

required

The internal ID of the public product.

Example:

"prod_xxxxxxxxxxxxx"

data.product.title

string

required

The title of the product. Use for Whop 4.0.

data.company

object

required

The company the dispute is against.

Show child attributes

data.company.id

string

required

The ID of the company

Example:

"biz_xxxxxxxxxxxxxx"

data.company.title

string

required

The written name of the company.

data.payment

object

required

The payment that got disputed

Show child attributes

data.payment.id

string

required

The payment ID

Example:

"pay_xxxxxxxxxxxxxx"

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Refund updated Retrieve dispute

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Query Parameters

Response