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 checkoutConfigurationListResponse of client.checkoutConfigurations.list({
company_id: 'biz_xxxxxxxxxxxxxx',
})) {
console.log(checkoutConfigurationListResponse.id);
}{
"data": [
{
"id": "ch_xxxxxxxxxxxxxxx",
"company_id": "<string>",
"mode": "payment",
"currency": "usd",
"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>",
"payment_method_configuration": {
"enabled": [
"acss_debit"
],
"disabled": [
"acss_debit"
],
"include_platform_defaults": true
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}Returns a paginated list of checkout configurations for a company, with optional filtering by plan and creation date.
Required permissions:
checkout_configuration: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 checkoutConfigurationListResponse of client.checkoutConfigurations.list({
company_id: 'biz_xxxxxxxxxxxxxx',
})) {
console.log(checkoutConfigurationListResponse.id);
}{
"data": [
{
"id": "ch_xxxxxxxxxxxxxxx",
"company_id": "<string>",
"mode": "payment",
"currency": "usd",
"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>",
"payment_method_configuration": {
"enabled": [
"acss_debit"
],
"disabled": [
"acss_debit"
],
"include_platform_defaults": true
}
}
],
"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 checkout configurations for.
"biz_xxxxxxxxxxxxxx"
The sort direction for ordering results, either ascending or descending.
asc, desc Filter checkout configurations to only those associated with this plan identifier.
"plan_xxxxxxxxxxxxx"
Only return checkout configurations created before this timestamp.
"2023-12-01T05:00:00.401Z"
Only return checkout configurations created after this timestamp.
"2023-12-01T05:00:00.401Z"
Was this page helpful?