List setup intents

JavaScript

import Whop from '@whop/sdk';

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

// 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": "<string>",
      "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": "<string>",
          "exp_month": 42,
          "exp_year": 42
        }
      },
      "metadata": {}
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

setup_intents

JavaScript

import Whop from '@whop/sdk';

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

// 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": "<string>",
      "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": "<string>",
          "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

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 setup intents for

Example:

"biz_xxxxxxxxxxxxxx"

direction

enum<string> | null

The direction to sort the setup intents 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 SetupIntent.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The setup intent ID

Example:

"sint_xxxxxxxxxxxxx"

data.status

enum<string>

required

The status of the setup intent

Available options:

processing,

succeeded,

canceled,

requires_action

data.created_at

string<date-time>

required

The datetime the payment was created

Example:

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

data.error_message

string | null

required

The error message, if any.

data.company

object

required

The company of the setup intent

Show child attributes

data.company.id

string

required

The ID (tag) of the company.

Example:

"biz_xxxxxxxxxxxxxx"

data.checkout_configuration

object

required

The checkout configuration associated with the setup intent

Show child attributes

data.checkout_configuration.id

string

required

The ID of the checkout configuration

Example:

"ch_xxxxxxxxxxxxxxx"

data.member

object

required

The member connected to the setup intent

Show child attributes

data.member.id

string

required

The ID of the member

data.member.user

object

required

The user for this member, if any.

Show child attributes

data.member.user.id

string

required

The internal ID of the user account.

data.member.user.email

string | null

required

The digital mailing address of the user.

data.member.user.name

string | null

required

The user's full name.

data.member.user.username

string

required

The whop username.

data.payment_method

object

required

The payment method created during the setup, if available.

Show child attributes

data.payment_method.id

string

required

The ID of the payment method

Example:

"payt_xxxxxxxxxxxxx"

data.payment_method.created_at

string<date-time>

required

The date and time the payment method was created

Example:

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

data.payment_method.payment_method_type

enum<string>

required

The payment method type of the payment method

Available options:

acss_debit,

affirm,

afterpay_clearpay,

alipay,

alma,

amazon_pay,

apple_pay,

au_becs_debit,

bacs_debit,

bancontact,

billie,

blik,

boleto,

card,

cashapp,

crypto,

eps,

fpx,

giropay,

google_pay,

grabpay,

ideal,

kakao_pay,

klarna,

konbini,

kr_card,

link,

mobilepay,

multibanco,

naver_pay,

nz_bank_account,

oxxo,

p24,

pay_by_bank,

payco,

paynow,

pix,

promptpay,

revolut_pay,

samsung_pay,

satispay,

sepa_debit,

sofort,

swish,

twint,

us_bank_account,

wechat_pay,

zip,

bizum,

capchase_pay,

kriya,

mondu,

ng_wallet,

paypay,

sequra,

scalapay,

vipps,

custom,

customer_balance,

gopay,

mb_way,

ng_bank,

ng_bank_transfer,

ng_card,

ng_market,

ng_ussd,

paypal,

payto,

qris,

rechnung,

south_korea_market,

kr_market,

shopeepay,

upi,

sunbit,

netbanking,

id_bank_transfer,

demo_pay,

shop_pay,

sezzle,

coinbase,

splitit,

platform_balance,

apple,

venmo,

unknown

data.payment_method.card

object

required

The card data associated with the payment method, if its a debit or credit card.

Show child attributes

data.payment_method.card.brand

enum<string> | null

required

Card brand (e.g., VISA, MASTERCARD).

Available options:

mastercard,

visa,

amex,

discover,

unionpay,

jcb,

diners,

link,

troy,

visadankort,

visabancontact,

china_union_pay,

rupay,

jcbrupay,

elo,

maestro,

unknown

data.payment_method.card.last4

string | null

required

Last four digits of the card.

data.payment_method.card.exp_month

integer | null

required

Card expiration month, like 03 for March.

Example:

42

data.payment_method.card.exp_year

integer | null

required

Card expiration year, like 27 for 2027.

Example:

42

data.metadata

object

required

The metadata associated with the setup intent

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?

Retrieve checkout configuration Retrieve setup intent

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

List setup intents

Authorizations

Query Parameters

Response