Skip to main content
GET
/
setup_intents
JavaScript
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 setupIntentListResponse of client.setupIntents.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(setupIntentListResponse.id);
}
{
  "data": [
    {
      "id": "sint_xxxxxxxxxxxxx",
      "status": "processing",
      "created_at": "2023-12-01T05:00:00.401Z",
      "error_message": "Your card was declined.",
      "company": {
        "id": "biz_xxxxxxxxxxxxxx"
      },
      "checkout_configuration": {
        "id": "ch_xxxxxxxxxxxxxxx"
      },
      "member": {
        "id": "<string>",
        "user": {
          "id": "<string>",
          "email": "<string>",
          "name": "<string>",
          "username": "<string>"
        }
      },
      "payment_method": {
        "id": "payt_xxxxxxxxxxxxx",
        "created_at": "2023-12-01T05:00:00.401Z",
        "payment_method_type": "acss_debit",
        "card": {
          "brand": "mastercard",
          "last4": "4242",
          "exp_month": 42,
          "exp_year": 42
        }
      },
      "metadata": {}
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

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 ***************************

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 unique identifier of the company to list setup intents for.

Example:

"biz_xxxxxxxxxxxxxx"

​
direction
enum<string> | null

The sort direction for ordering results, either ascending or descending.

Available options:
asc,
desc
​
created_before
string<date-time> | null

Only return setup intents created before this timestamp.

Example:

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

​
created_after
string<date-time> | null

Only return setup intents created after this timestamp.

Example:

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

Response

A successful response

The connection type for SetupIntent.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.