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 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": "Product Not Received",
"plan": {
"id": "plan_xxxxxxxxxxxxx"
},
"product": {
"id": "prod_xxxxxxxxxxxxx",
"title": "Pickaxe Analytics"
},
"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
}
}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:readplan:basic:readaccess_pass:basic:readcompany:basic:readpayment:basic:readimport 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 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": "Product Not Received",
"plan": {
"id": "plan_xxxxxxxxxxxxx"
},
"product": {
"id": "prod_xxxxxxxxxxxxx",
"title": "Pickaxe Analytics"
},
"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
}
}A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
42
Returns the last n elements from the list.
42
The unique identifier of the company to list disputes for.
"biz_xxxxxxxxxxxxxx"
The sort direction for ordering results, either ascending or descending.
asc, desc Only return disputes created before this timestamp.
"2023-12-01T05:00:00.401Z"
Only return disputes created after this timestamp.
"2023-12-01T05:00:00.401Z"
Was this page helpful?