Skip to main content
GET
/
checkout_configurations
JavaScript
import Whopsdk from 'whopsdk';

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

// Automatically fetches more pages as needed.
for await (const checkoutConfigurationListResponse of client.checkoutConfigurations.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(checkoutConfigurationListResponse.id);
}
{
  "data": [
    {
      "id": "ch_xxxxxxxxxxxxxxx",
      "company_id": "<string>",
      "plan": {
        "id": "plan_xxxxxxxxxxxxx",
        "visibility": "visible",
        "plan_type": "renewal",
        "release_method": "buy_now",
        "currency": "usd",
        "billing_period": 42,
        "expiration_days": 42,
        "initial_price": 6.9,
        "renewal_price": 6.9,
        "trial_period_days": 42
      },
      "affiliate_code": "<string>",
      "metadata": {},
      "redirect_url": "<string>",
      "purchase_url": "<string>"
    }
  ],
  "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 checkout configurations for

Example:

"biz_xxxxxxxxxxxxxx"

direction
enum<string> | null

The direction to sort the checkout configurations by The direction of the sort.

Available options:
asc,
desc
plan_id
string | null

The ID of the plan to filter checkout configurations by

Example:

"plan_xxxxxxxxxxxxx"

Response

A successful response

The connection type for CheckoutSession.

data
array | null
required

A list of nodes.

page_info
object
required

Information to aid in pagination.

I