Whop TypeScript API Library

https://github.com/whopio/whopsdk-typescript
Admin
This library provides convenient access to the Whop REST API from server-side TypeScript or...
Tokens:351,927
Snippets:2,344
Trust Score:9.1
License:Apache-2.0
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GET /setup_intents

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/CommerceClient.md

Lists setup intents. Returns a paginated list of setup intent items.

```APIDOC
## GET /setup_intents

### Description
Lists setup intents.

### Method
GET

### Endpoint
/setup_intents

### Parameters
#### Query Parameters
- **account_id** (string) - Required - The account ID to list setup intents for.

### Response
#### Success Response (200)
- **data** (array) - List of setup intent items.
- **has_more** (boolean) - Whether there are more results.

#### Response Example
```json
{
  "data": [
    {
      "id": "si_xxx",
      "status": "requires_action",
      "client_secret": "...",
      "return_url": "https://example.com/return",
      "payment_method_id": "pm_xxx"
    }
  ],
  "has_more": false
}
```
```

--------------------------------

### POST /setup_intents/direct

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/CommerceClient.md

Creates a setup intent directly. Returns the created setup intent object.

```APIDOC
## POST /setup_intents/direct

### Description
Creates a setup intent directly.

### Method
POST

### Endpoint
/setup_intents/direct

### Parameters
#### Request Body
- **account_id** (string) - Required - The account ID for which to create the setup intent.

### Request Example
```json
{
  "account_id": "biz_xxx"
}
```

### Response
#### Success Response (200)
- **id** (string) - The setup intent ID.
- **status** (string) - The status of the setup intent.
- **client_secret** (string) - The client secret.
- **return_url** (string) - The return URL.
- **payment_method_id** (string) - The payment method ID.

#### Response Example
```json
{
  "id": "si_xxx",
  "status": "requires_action",
  "client_secret": "...",
  "return_url": "https://example.com/return",
  "payment_method_id": "pm_xxx"
}
```
```

--------------------------------

### GET /setup_intents/{id}

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/CommerceClient.md

Retrieves a setup intent by its ID. Returns the setup intent object.

```APIDOC
## GET /setup_intents/{id}

### Description
Retrieves a setup intent by its ID.

### Method
GET

### Endpoint
/setup_intents/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The setup intent ID.

### Response
#### Success Response (200)
- **id** (string) - The setup intent ID.
- **status** (string) - The status of the setup intent.
- **client_secret** (string) - The client secret.
- **return_url** (string) - The return URL.
- **payment_method_id** (string) - The payment method ID.

#### Response Example
```json
{
  "id": "si_xxx",
  "status": "requires_action",
  "client_secret": "...",
  "return_url": "https://example.com/return",
  "payment_method_id": "pm_xxx"
}
```
```

--------------------------------

### Create a setup intent with client.setupIntents.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Saves a buyer's payment method for later without charging it. Pass a `confirmation_token` for a method the buyer just supplied through the payment elements in setup mode, or a `payment_method_id` already on file to re-verify it.
The response is the setup intent as created, not its outcome: while it is `requires_action` the buyer still has a step, so hand `client_secret` to the elements' `handleNextAction` or poll Retrieve setup status.
A buyer's own token holding `member:payment_methods:use` may create a setup intent for itself from a confirmation token.

```typescript
await client.setupIntents.create({
    account_id: "biz_xxxxxxxxxxxxxx"
});

```

--------------------------------

### POST /setup_intents

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/CommerceClient.md

Creates a new setup intent. Returns the created setup intent object.

```APIDOC
## POST /setup_intents

### Description
Creates a new setup intent.

### Method
POST

### Endpoint
/setup_intents

### Parameters
#### Request Body
- **account_id** (string) - Required - The account ID for which to create the setup intent.

### Request Example
```json
{
  "account_id": "biz_xxx"
}
```

### Response
#### Success Response (200)
- **id** (string) - The setup intent ID (e.g., `si_...`).
- **status** (string) - The status of the setup intent (e.g., `requires_action`).
- **client_secret** (string) - The client secret used for confirmation.
- **return_url** (string) - The return URL.
- **payment_method_id** (string) - The payment method ID.

#### Response Example
```json
{
  "id": "si_xxx",
  "status": "requires_action",
  "client_secret": "...",
  "return_url": "https://example.com/return",
  "payment_method_id": "pm_xxx"
}
```
```

--------------------------------

### client.setupIntents.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Saves a buyer's payment method for later without charging it. Pass a `confirmation_token` for a method the buyer just supplied through the payment elements in setup mode, or a `payment_method_id` already on file to re-verify it. The response is the setup intent as created, not its outcome: while it is `requires_action` the buyer still has a step, so hand `client_secret` to the elements' `handleNextAction` or poll Retrieve setup status. A buyer's own token holding `member:payment_methods:use` may create a setup intent for itself from a confirmation token.

```APIDOC
## [POST] /setup_intents

### Description
Saves a buyer's payment method for later without charging it. Pass a `confirmation_token` for a method the buyer just supplied through the payment elements in setup mode, or a `payment_method_id` already on file to re-verify it. The response is the setup intent as created, not its outcome: while it is `requires_action` the buyer still has a step, so hand `client_secret` to the elements' `handleNextAction` or poll Retrieve setup status. A buyer's own token holding `member:payment_methods:use` may create a setup intent for itself from a confirmation token.

### Method
POST

### Endpoint
/setup_intents

### Parameters
#### Request Body
- **account_id** (string) - Required - The account ID for which to create the setup intent.
- **confirmation_token** (string) - Optional - A token representing the payment method to save.
- **payment_method_id** (string) - Optional - The ID of an existing payment method to save.

### Request Example
```json
{
  "account_id": "biz_xxxxxxxxxxxxxx"
}
```

### Response
#### Success Response (200)
- **id** (string) - The setup intent ID.
- **status** (string) - The status of the setup intent.
- **client_secret** (string) - The client secret for the setup intent.

#### Response Example
```json
{
  "id": "setup_intent_id",
  "status": "requires_action",
  "client_secret": "secret"
}
```
```

--------------------------------

### GET /setup_intents/{setup_intent_id}/status

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/CommerceClient.md

Retrieves the status of a setup intent. Returns the setup intent object with its current status.

```APIDOC
## GET /setup_intents/{setup_intent_id}/status

### Description
Retrieves the status of a setup intent.

### Method
GET

### Endpoint
/setup_intents/{setup_intent_id}/status

### Parameters
#### Path Parameters
- **setup_intent_id** (string) - Required - The setup intent ID.

### Response
#### Success Response (200)
- **id** (string) - The setup intent ID.
- **status** (string) - The status of the setup intent.
- **client_secret** (string) - The client secret.
- **return_url** (string) - The return URL.
- **payment_method_id** (string) - The payment method ID.

#### Response Example
```json
{
  "id": "si_xxx",
  "status": "requires_action",
  "client_secret": "...",
  "return_url": "https://example.com/return",
  "payment_method_id": "pm_xxx"
}
```
```

--------------------------------

### List setup intents with client.setupIntents.list

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Lists setup intents newest first. An account API key lists its own account; a user token lists every account it can read, or one account with `account_id`.
`client_secret` is always null on list rows; retrieve the setup intent for it.

```typescript
const pageableResponse = await client.setupIntents.list();
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.setupIntents.list();
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

```

--------------------------------

### POST /setup_intents/{setup_intent_id}/return_url

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/CommerceClient.md

Updates the return URL for a setup intent. Returns the updated setup intent.

```APIDOC
## POST /setup_intents/{setup_intent_id}/return_url

### Description
Updates the return URL for a setup intent.

### Method
POST

### Endpoint
/setup_intents/{setup_intent_id}/return_url

### Parameters
#### Path Parameters
- **setup_intent_id** (string) - Required - The setup intent ID.

#### Request Body
- **return_url** (string) - Required - The new return URL.

### Request Example
```json
{
  "return_url": "https://example.com/new-return"
}
```

### Response
#### Success Response (200)
- **id** (string) - The setup intent ID.
- **status** (string) - The status of the setup intent.
- **client_secret** (string) - The client secret.
- **return_url** (string) - The updated return URL.
- **payment_method_id** (string) - The payment method ID.

#### Response Example
```json
{
  "id": "si_xxx",
  "status": "requires_action",
  "client_secret": "...",
  "return_url": "https://example.com/new-return",
  "payment_method_id": "pm_xxx"
}
```
```

--------------------------------

### setupIntents

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/endpoints.md

Endpoints for managing setup intents.

```APIDOC
## GET /setup_intents

### Description
Lists all setup intents.

### Method
GET

### Endpoint
/setup_intents

```

```APIDOC
## POST /setup_intents

### Description
Creates a new setup intent.

### Method
POST

### Endpoint
/setup_intents

```

```APIDOC
## GET /setup_intents/{id}

### Description
Retrieves a specific setup intent by ID.

### Method
GET

### Endpoint
/setup_intents/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The setup intent ID.

```

```APIDOC
## PATCH /setup_intents/{setup_intent_id}/return_url

### Description
Updates the return URL for a specific setup intent.

### Method
PATCH

### Endpoint
/setup_intents/{setup_intent_id}/return_url

### Parameters
#### Path Parameters
- **setup_intent_id** (string) - Required - The setup intent ID.

```

```APIDOC
## GET /setup_intents/{setup_intent_id}/status

### Description
Retrieves the status of a specific setup intent.

### Method
GET

### Endpoint
/setup_intents/{setup_intent_id}/status

### Parameters
#### Path Parameters
- **setup_intent_id** (string) - Required - The setup intent ID.

```

```APIDOC
## POST /setup_intents/direct

### Description
Creates a direct setup intent.

### Method
POST

### Endpoint
/setup_intents/direct

```

--------------------------------

### Install @whop/sdk with npm

Source: https://github.com/whopio/whopsdk-typescript/blob/main/README.md

Install the @whop/sdk package using npm.

```sh
npm i -s @whop/sdk
```

--------------------------------

### Basic and advanced fetch usage

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/WhopClient.md

Examples of using client.fetch. The first shows a basic GET request to a relative path. The second shows a POST with per-request overrides for timeout, retries, and headers, including error handling.

```typescript
// Basic call — reverse-proxy an endpoint the SDK does not model yet
const client = new WhopClient({ token: "key_xxx" });
const res = await client.fetch("/v2/ping");
console.log(res.status, await res.text());

// Advanced: relative path + per-request overrides
const res2 = await client.fetch("custom/resource", { method: "POST", body: JSON.stringify({ a: 1 }) }, {
    timeoutInSeconds: 30,
    maxRetries: 0,
    headers: { "X-Custom": "1" },
});
if (!res2.ok) {
    throw new Error(`request failed with ${res2.status}`);
}
```

--------------------------------

### me method usage example

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/UsersClient.md

Example call to client.users.me with include_balance, include_balance_history, interval, and time_zone. Logs user id, username, and balance.

```typescript
const user = await client.users.me({
    include_balance: true,
    include_balance_history: true,
    interval: "day",
    time_zone: "America/New_York",
});
console.log(user.id, user.username, user.balance);
```

--------------------------------

### Retrieve a setup intent with client.setupIntents.retrieve

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Returns one setup intent. Related records are ids — once `status` is `succeeded`, `payment_method_id` is the saved method to charge or retrieve. The buyer's own token may retrieve a setup intent that belongs to it.

```typescript
await client.setupIntents.retrieve({
    id: "id"
});

```

--------------------------------

### client.setupIntents.list

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Lists setup intents newest first. An account API key lists its own account; a user token lists every account it can read, or one account with `account_id`. `client_secret` is always null on list rows — retrieve the setup intent for it.

```APIDOC
## [GET] /setup_intents

### Description
Lists setup intents newest first. An account API key lists its own account; a user token lists every account it can read, or one account with `account_id`. `client_secret` is always null on list rows — retrieve the setup intent for it.

### Method
GET

### Endpoint
/setup_intents

### Parameters
#### Query Parameters
- **account_id** (string) - Optional - The account ID to filter setup intents by.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **data** (array) - List of setup intents.

#### Response Example
```json
{
  "data": []
}
```
```

--------------------------------

### Create a direct setup intent with client.setupIntents.direct.create()

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Saves a card for later charges from card details the caller holds itself, for PCI-compliant integrators. Card details are accepted only on the vault host; raw card details sent to the regular host are refused. The setup runs in the background; poll Retrieve setup status for the outcome and for any buyer action like 3D Secure. On success, the saved payment method appears on the setup_intent.succeeded webhook and in List payment methods.

```typescript
await client.setupIntents.direct.create({
    account_id: "biz_xxxxxxxxxxxxxx",
    billing_details: {
        address: {
            country: "US",
            postal_code: "94105"
        },
        email: "dana@shinetime.example",
        name: "Dana Shine"
    },
    payment_method: {
        type: "card"
    }
});

```

--------------------------------

### client.setupIntents.retrieve

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Returns one setup intent. Related records are ids — once `status` is `succeeded`, `payment_method_id` is the saved method to charge or retrieve. The buyer's own token may retrieve a setup intent that belongs to it.

```APIDOC
## [GET] /setup_intents/{id}

### Description
Returns one setup intent. Related records are ids — once `status` is `succeeded`, `payment_method_id` is the saved method to charge or retrieve. The buyer's own token may retrieve a setup intent that belongs to it.

### Method
GET

### Endpoint
/setup_intents/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the setup intent to retrieve.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **id** (string) - The setup intent ID.
- **status** (string) - The status of the setup intent.
- **payment_method_id** (string) - The ID of the saved payment method, if succeeded.

#### Response Example
```json
{
  "id": "setup_intent_id",
  "status": "succeeded",
  "payment_method_id": "pm_123"
}
```
```

--------------------------------

### Retrieve setup intent status with client.setupIntents.retrieveStatus

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Retrieves how far a setup has got and what the buyer must do next, if anything. Collection runs in the background, so poll this rather than reading the create response. Accepts either a secret key or the setup's own `client_secret`, so the surface collecting the payment method can poll it directly.

```typescript
await client.setupIntents.retrieveStatus({
    setup_intent_id: "setup_intent_id"
});

```

--------------------------------

### Update return URL for a setup intent with client.setupIntents.updateReturnUrl

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Changes where the buyer lands after completing an off-site step, up until they return. Accepts either a secret key or the setup's own `client_secret`, so the surface that knows the final destination can set it.

```typescript
await client.setupIntents.updateReturnUrl({
    setup_intent_id: "setup_intent_id",
    return_url: "https://shinetime.example/checkout/thanks"
});

```

--------------------------------

### client.exports.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Starts an asynchronous export of a resource for an account. Returns the export in `pending`; poll `GET /exports/{id}` until `download_url` is set.

```APIDOC
## client.exports.create

### Description
Starts an asynchronous export of a resource for an account. Returns the export in `pending`; poll `GET /exports/{id}` until `download_url` is set.

### Method
POST

### Endpoint
/exports

### Parameters
#### Request Body
- **resource** (string) - Required - The resource to export. Example: "ad_campaigns".

#### Request Options
- **requestOptions** (ExportsClient.RequestOptions) - Optional - Options for the request.

### Request Example
```typescript
await client.exports.create({
    resource: "ad_campaigns"
});
```

### Response
#### Success Response (200)
- **response** (Whop.Export) - The created export object.

#### Response Example
```json
{
  "id": "export_id",
  "status": "pending",
  "resource": "ad_campaigns"
}
```
```

--------------------------------

### Create export

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Starts an asynchronous export for the specified resource. The returned export is in `pending` status; poll `GET /exports/{id}` until `download_url` is set.

```typescript
await client.exports.create({
    resource: "ad_campaigns"
});
```

--------------------------------

### Generate media asynchronously with client.media.generate

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Starts an asynchronous AI media generation job billed from the account's balance. Poll `GET /media/{id}` until the asset is `ready`.

```typescript
await client.media.generate({
    prompt: "A 9:16 product showcase of a cordless power scrubber",
    type: "video"
});
```

--------------------------------

### Create, publish, and list products

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/PlansProductsVariants.md

Shows how to create a product, publish it, and list products with pagination. The example creates a product with account_id and title, then publishes it, and lists products in descending order with a first parameter.

```typescript
// Create a product, then publish it
const product = await client.products.create({
    account_id: "biz_xxx",
    title: "Pro Resource Pack",
    description: "Downloadable assets",
});
await client.products.publish({ id: product.id });

// List only membership-style products, newest first
const page = await client.products.list({ direction: "desc", first: 50 });
for await (const item of page) console.log(item.id, item.title);
```

--------------------------------

### client.media.generate

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Starts an AI media generation job billed from the account's balance. Generation is asynchronous — poll GET /media/{id} until the asset is ready, then use file.id anywhere attachments are accepted.

```APIDOC
## client.media.generate

### Description
Starts an AI media generation job billed from the account's balance. Generation is asynchronous — poll `GET /media/{id}` until the asset is `ready`, then use `file.id` anywhere attachments are accepted.

### Method
POST

### Endpoint
/media/generate

### Parameters
#### Request Body
- **prompt** (string) - Required - The prompt describing the media to generate.
- **type** (string) - Required - The type of media to generate (e.g., "video").

### Request Example
```typescript
await client.media.generate({
    prompt: "A 9:16 product showcase of a cordless power scrubber",
    type: "video"
});
```

### Response
#### Success Response (200)
Returns the media asset details.

#### Response Example
```json
{
  "id": "media_xxxxxxxxxxxxx",
  "status": "processing"
}
```
```

--------------------------------

### Build the project

Source: https://github.com/whopio/whopsdk-typescript/blob/main/CONTRIBUTING.md

Builds the project.

```bash
pnpm build
```

--------------------------------

### Custom fetch request with client.fetch

Source: https://github.com/whopio/whopsdk-typescript/blob/main/README.md

Use the low-level `fetch` method to call custom API endpoints while benefiting from SDK-level configuration like authentication, retries, timeouts, and logging. The example shows a GET request with a 30-second timeout, 3 retries, and a custom header.

```typescript
const response = await client.fetch("/v1/custom/endpoint", {
    method: "GET",
}, {
    timeoutInSeconds: 30,
    maxRetries: 3,
    headers: {
        "X-Custom-Header": "custom-value",
    },
});

const data = await response.json();
```

--------------------------------

### Pulse events to get anonymized money movement feed

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Returns a fully anonymized feed of recent platform-wide money movement, most recent first. Items carry only type, event name, USD amount, coarse location, and timestamp coarsened to the start of the minute; missing fields are omitted. No auth required.

```typescript
const pageableResponse = await client.events.pulse();
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.events.pulse();
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;
```

--------------------------------

### GET /disputes/summary

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/ResolutionAndDisputesClient.md

Get summary of disputes with per-filter counts.

```APIDOC
## GET /disputes/summary

### Description
Get summary of disputes with per-filter counts.

### Method
GET

### Endpoint
/disputes/summary

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **counts** (object) - Per-filter counts.

#### Response Example
```json
{
  "counts": {
    "needs_response": 1
  }
}
```
```

--------------------------------

### Install dependencies with pnpm

Source: https://github.com/whopio/whopsdk-typescript/blob/main/CONTRIBUTING.md

Installs project dependencies using the pnpm package manager.

```bash
pnpm install
```

--------------------------------

### client.setupIntents.direct.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Saves a card for later charges from card details the caller holds itself, for integrators whose own systems are PCI compliant. Card details are accepted only on the vault host, where the card is tokenized before it reaches Whop; the official SDKs route this operation there, and raw card details sent to the regular host are refused. (Whop's own clients, which tokenize with the Basis Theory SDK, send the resulting token intent id to the regular host.) The setup runs in the background: poll Retrieve setup status for its outcome and for anything the buyer must still do, such as 3D Secure. Once it succeeds, the saved payment method arrives on the `setup_intent.succeeded` webhook and in List payment methods for the member.

```APIDOC
## [POST] client.setupIntents.direct.create

### Description
Saves a card for later charges from card details the caller holds itself, for integrators whose own systems are PCI compliant. Card details are accepted only on the vault host, where the card is tokenized before it reaches Whop; the official SDKs route this operation there, and raw card details sent to the regular host are refused. (Whop's own clients, which tokenize with the Basis Theory SDK, send the resulting token intent id to the regular host.) The setup runs in the background: poll Retrieve setup status for its outcome and for anything the buyer must still do, such as 3D Secure. Once it succeeds, the saved payment method arrives on the `setup_intent.succeeded` webhook and in List payment methods for the member.

### Method
POST

### Endpoint
client.setupIntents.direct.create

### Parameters
#### Request Parameters
- **request** (`Whop.setupIntents.CreateDirectRequest`) - Required - The request object.
- **requestOptions** (`DirectClient.RequestOptions`) - Optional - The request options.

### Request Example
```typescript
await client.setupIntents.direct.create({
    account_id: "biz_xxxxxxxxxxxxxx",
    billing_details: {
        address: {
            country: "US",
            postal_code: "94105"
        },
        email: "dana@shinetime.example",
        name: "Dana Shine"
    },
    payment_method: {
        type: "card"
    }
});
```

### Response
#### Success Response
- **result** (`Whop.SetupIntent`) - The created setup intent.
```

--------------------------------

### Create a topup with client.topups.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/FinanceClient.md

Creates a balance top-up for a business account. The request requires an account_id, amount, and currency. Returns a Whop.Topup entity with crypto/wallet funding instructions.

```typescript
const topup = await client.topups.create({ account_id: "biz_xxx", amount: 500, currency: "usd" });
```

--------------------------------

### Create app and build with Whop SDK

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/AppsAndDevToolsClient.md

Use this example to create a new Whop app and then create a build for that app. The app must be created first to obtain its ID, which is then passed to the build creation call.

```typescript
const app = await client.apps.create({ name: "My App", type: "embed" });
const build = await client.appBuilds.create({ app_id: app.id, platform: "web", version: "1.0.0" });
```

--------------------------------

### Create a course with `client.courses.create`

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Creates a new course within an experience, with optional chapters, lessons, and a certificate. Requires the `courses:update` permission. The example passes only `experience_id` and `title`.

```typescript
await client.courses.create({
    experience_id: "exp_xxxxxxxxxxxxxx",
    title: "title"
});

```

--------------------------------

### Validate Whop pixel installation with client.events.validatePixel

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Checks whether the Whop pixel is installed for an account. Recent pixel events count as proof; pass a url to check a specific page. installed is only true when the pixel was actually seen.

```typescript
await client.events.validatePixel();
```

--------------------------------

### Create a product with client.products.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Creates a new product for an account. The request requires a title.

```typescript
await client.products.create({
    title: "Interior Deep Clean"
});

```

--------------------------------

### client.courseLessons.start

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Records that the current user has started viewing a lesson, creating progress tracking records.

```APIDOC
## client.courseLessons.start

### Description
Records that the current user has started viewing a lesson, creating progress tracking records.

### Method
POST

### Endpoint
/course-lessons/start

### Parameters
#### Request Body
- **request** (Whop.StartCourseLessonsRequest) - Required - The request object containing the lesson ID.
- **requestOptions** (CourseLessonsClient.RequestOptions) - Optional - Additional request options.

### Request Example
```json
{
  "lesson_id": "lesson_id"
}
```

### Response
#### Success Response (200)
- **boolean** - Success indicator.

#### Response Example
```json
true
```
```

--------------------------------

### transferOwnership usage example

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/AccountsClient.md

Example of transferring account ownership with an email identifier and as_partner flag. Catches BadRequestError for invalid requests.

```typescript
try {
    const account = await client.accounts.transferOwnership({
        id: "biz_xxx",
        identifier: "friend@example.com",
        as_partner: true,
        message: "Congrats on taking over!",
    });
} catch (err) {
    if (err instanceof Whop.BadRequestError) {
        console.error("message without as_partner, or invalid identifier", err.body);
    }
    throw err;
}
```

--------------------------------

### Create account link example

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/MembershipClient.md

Creates an account link with account_id, use_case, and connected_account_id, then logs the URL to send to the merchant for approval.

```typescript
const link = await client.accountLinks.create({
    account_id: "biz_parent",
    use_case: "connect_account",
    connected_account_id: "biz_child",
});
console.log(link.url); // send the merchant here to approve the connection
```

--------------------------------

### list usage example

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/AccountsClient.md

Example of calling the list method with status and first parameters, then iterating over the returned pages to log account details.

```typescript
const page = await client.accounts.list({ status: "active", first: 50 });
for await (const account of page) {
    console.log(account.id, account.business_name, account.business_type);
}
```

--------------------------------

### Create a course lesson with client.courseLessons.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Creates a lesson within a chapter; specify the lesson type (e.g., `text`). Requires `courses:update` permission.

```typescript
await client.courseLessons.create({
    chapter_id: "chap_xxxxxxxxxxxxx",
    lesson_type: "text"
});

```

--------------------------------

### Start WebAuthn registration with passkeys challenge

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/UsersClient.md

Starts a WebAuthn registration ceremony by requesting a challenge with challenge_type 'registration'. The returned challenge is logged to the console.

```typescript
// Start WebAuthn registration
const challenge = await client.users.passkeys.challenge({ challenge_type: "registration" });
console.log(challenge);
```

--------------------------------

### Create a passkey with client.users.passkeys.create()

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Registers a passkey for the authenticated user from the attestation a browser produced for a `registration` challenge. Mint that challenge first with `POST /users/me/passkeys/challenge`; it is single-use and expires 5 minutes after it is issued. Requires a user session.

```typescript
await client.users.passkeys.create({
    attestation_object: "YXR0ZXN0YXRpb24",
    client_data_json: "Y2xpZW50LWRhdGE",
    credential_id: "bmV3LWNyZWRlbnRpYWw",
    nickname: "Work laptop"
});
```

--------------------------------

### Supplier type and get method

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/FetcherCore.md

Defines the Supplier type and its get method, which resolves a value, a promise, or a function returning either. Used to lazily evaluate values, such as header values, in the fetcher.

```typescript
// src/core/fetcher/Supplier.ts
export type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);

export const Supplier = {
    get: async <T>(supplier: Supplier<T>): Promise<T> => {
        if (typeof supplier === "function") {
            return (supplier as () => T)();
        } else {
            return supplier;
        }
    },
};
```

--------------------------------

### Configure WhopClient with full options and per-request overrides

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/configuration.md

Full configuration example for the Whop SDK client, showing how to set token refresh, environment, API version, idempotency key, timeout, retries, custom headers, logging, and a custom fetch. Also demonstrates per-request overrides for timeout, retries, abort signal, and query parameters.

```typescript
import { WhopClient, WhopEnvironment, logging } from "@whop/sdk";

const client = new WhopClient({
    token: async () => (await refreshToken()).token,
    environment: WhopEnvironment.Sandbox,
    apiVersionDate: "2026-09-29",
    idempotencyKey: undefined,          // set per-request when charging
    timeoutInSeconds: 15,
    maxRetries: 3,
    headers: { "X-Custom-Trace": "abc" },
    logging: { level: logging.LogLevel.Debug, silent: false },
    fetch: myInstrumentedFetch,
});

await client.payments.list({ account_id: "biz_xxx" }, {
    timeoutInSeconds: 30,
    maxRetries: 0,
    abortSignal: AbortSignal.timeout(20_000),
    queryParams: { expand: "line_items" },
});
```

--------------------------------

### Get resolution center case summary (client.resolutionCenterCases.summary)

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Aggregates the same cases that GET /resolution_center_cases lists, using the same filters. Useful for building status tabs and issue filters without paging the whole list.

```typescript
await client.resolutionCenterCases.summary();
```

--------------------------------

### List products with pagination using client.products.list

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Returns a paginated list of products. Omit `account_id` to search the public marketplace. The example shows async iteration, manual pagination with `hasNextPage()`/`getNextPage()`, and accessing the underlying response.

```typescript
const pageableResponse = await client.products.list({
    visibilities: ["visible"],
    access_pass_types: ["regular"]
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.products.list({
    visibilities: ["visible"],
    access_pass_types: ["regular"]
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

```

--------------------------------

### client.experiments.activate

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Starts or resumes an experiment or feature flag so evaluation begins serving it. Activating a draft stamps started_at; resuming a paused experiment keeps the original start. Only drafts and paused experiments can be activated.

```APIDOC
## client.experiments.activate

### Description
Starts (or resumes) an experiment or feature flag so evaluation begins serving it. Activating a draft stamps `started_at`; resuming a paused experiment keeps the original start. Only drafts and paused experiments can be activated. Requires the corresponding experiment permission on the owning account, or Whop internal access for internal experiments.

### Method
POST

### Endpoint
client.experiments.activate

### Parameters
#### Request Body
- **request** (`Whop.ActivateExperimentsRequest`) - Required - The request payload containing the experiment ID.
- **requestOptions** (`ExperimentsClient.RequestOptions`) - Optional - Additional request options.

### Request Example
```typescript
await client.experiments.activate({
    id: "id"
});
```

### Response
#### Success Response (200)
- **response** (`Whop.Experiment`) - The activated experiment object.

#### Response Example
```json
{
  "id": "exp_123",
  "status": "active"
}
```
```

--------------------------------

### client.products.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Creates a new product for an account.

```APIDOC
## client.products.create

### Description
Creates a new product for an account.

### Method
create

### Endpoint
client.products.create

### Parameters
#### Request Body
- **title** (string) - Required - The title of the product.

### Request Example
```typescript
await client.products.create({
    title: "Interior Deep Clean"
});
```

### Response
#### Success Response (200)
- **product** (Product) - The created product.

#### Response Example
```json
{
  "id": "prod_123"
}
```
```

--------------------------------

### Activate an experiment with client.experiments.activate

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Starts or resumes an experiment or feature flag so evaluation begins serving it. Only drafts and paused experiments can be activated; activating a draft stamps started_at, while resuming keeps the original start.

```typescript
await client.experiments.activate({
    id: "id"
});
```

--------------------------------

### Configure proxy in Deno with Deno.createHttpClient

Source: https://github.com/whopio/whopsdk-typescript/blob/main/README.md

Configure a proxy for Deno using Deno.createHttpClient and the client fetch option.

```ts
import Whop from 'npm:@whop/sdk';

const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
const client = new Whop({
  fetchOptions: {
    client: httpClient,
  },
});
```

--------------------------------

### GET /webhooks

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/WebhooksClient.md

Lists webhooks.

```APIDOC
## [GET] /webhooks

### Description
Lists webhooks.

### Method
GET

### Endpoint
/webhooks

### Parameters
#### Query Parameters
- **request** (Whop.ListWebhooksRequest) - Required - The request object containing query parameters for listing webhooks.

### Response
#### Success Response (200)
- **body** (core.Page<Whop.WebhookListItem, Whop.ListWebhooksResponse>) - A paginated list of webhook items.

#### Response Example
```json
{
  "data": [
    {
      "id": "string",
      "url": "string",
      "event_types": ["string"]
    }
  ],
  "pagination": {
    "next_page": "string"
  }
}
```
```

--------------------------------

### client.courseLessons.create

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Create a new lesson within a course chapter. Lessons can contain video, text, or assessment content. Requires courses:update permission.

```APIDOC
## client.courseLessons.create

### Description
Create a new lesson within a course chapter. Lessons can contain video, text, or assessment content.

Required permissions:
- `courses:update`

### Method
POST

### Endpoint
/courseLessons

### Parameters
#### Request Body
- **chapter_id** (string) - Required - The ID of the chapter to add the lesson to.
- **lesson_type** (string) - Required - The type of lesson (e.g., "text", "video", "assessment").

### Request Example
```typescript
await client.courseLessons.create({
    chapter_id: "chap_xxxxxxxxxxxxx",
    lesson_type: "text"
});
```

### Response
#### Success Response (200)
Returns the created lesson.

#### Response Example
```json
{
  "id": "lesn_xxxxxxxxxxxxx",
  "chapter_id": "chap_xxxxxxxxxxxxx",
  "lesson_type": "text"
}
```
```

--------------------------------

### GET /resolutions

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/ResolutionAndDisputesClient.md

Lists all resolutions.

```APIDOC
## GET /resolutions

### Description
Retrieves a list of resolutions.

### Method
GET

### Endpoint
/resolutions

### Parameters
#### Query Parameters
- **page** (number) - Optional - Page number for pagination.
- **page_size** (number) - Optional - Number of items per page.

### Response
#### Success Response (200)
- **data** (array) - List of resolutions.
- **pagination** (object) - Pagination metadata.

#### Response Example
{
  "data": [],
  "pagination": {}
}
```

--------------------------------

### GET /dispute_alerts

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/ResolutionAndDisputesClient.md

List dispute alerts.

```APIDOC
## GET /dispute_alerts

### Description
List dispute alerts.

### Method
GET

### Endpoint
/dispute_alerts

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - List of dispute alerts.

#### Response Example
```json
{
  "data": [
    {
      "id": "string"
    }
  ]
}
```
```

--------------------------------

### GET /messages

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/CommunityAndMessaging.md

Lists messages with pagination.

```APIDOC
## GET /messages

### Description
Retrieves a paginated list of messages.

### Method
GET

### Endpoint
/messages

### Parameters
#### Query Parameters
- **channel_id** (string) - Optional - Filter by channel ID.
- **limit** (integer) - Optional - Number of messages to return.

### Request Example
```
GET /messages?channel_id=ch_123&limit=10
```

### Response
#### Success Response (200)
- **items** (array) - List of message items.
- **pagination** (object) - Pagination metadata.

#### Response Example
```json
{
  "items": [
    {
      "id": "msg_123",
      "channel_id": "ch_123",
      "content": "Hello"
    }
  ],
  "pagination": {
    "next_cursor": "def"
  }
}
```
```

--------------------------------

### Create an account with client.accounts.create()

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Creates an account. User tokens create business accounts; Account API keys create connected accounts. Tax fields (`tax_remitted_by`, `tax_type`, `product_tax_code_id`, `business_address`, `tax_identifiers`) are configured with Update Account, not at creation.

```typescript
await client.accounts.create();
```

--------------------------------

### GET /shipments

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/CommerceClient.md

Lists shipments with pagination.

```APIDOC
## GET /shipments

### Description
Lists shipments with pagination.

### Method
GET

### Endpoint
/shipments

### Parameters
#### Query Parameters
- **pagination** (object) - Optional - Pagination parameters (e.g., page, limit).

### Response
#### Success Response (200)
- **items** (array) - List of shipment items.
- **next** (string) - Pagination cursor for next page.

#### Response Example
{
  "items": [
    {
      "id": "ship_xxx",
      "tracking_number": "1Z999AA10123456784",
      "carrier": "UPS",
      "status": "in_transit"
    }
  ],
  "next": "cursor"
}

### Errors
- 400 - Bad Request
- 401 - Unauthorized
- 403 - Forbidden
- 404 - Not Found
- WhopError - Generic error
- WhopTimeoutError - Timeout error
```

--------------------------------

### List Checkout Configurations (client.checkoutConfigurations.list)

Source: https://github.com/whopio/whopsdk-typescript/blob/main/reference.md

Demonstrates how to list checkout configurations for an account, supporting both async iteration over pages and manual page-by-page navigation with hasNextPage() and getNextPage(). The underlying response can also be accessed via page.response.

```typescript
const pageableResponse = await client.checkoutConfigurations.list({
    account_id: "account_id"
});
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.checkoutConfigurations.list({
    account_id: "account_id"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

```

--------------------------------

### List and complete course lessons

Source: https://github.com/whopio/whopsdk-typescript/blob/main/_autodocs/api-reference/LearningClient.md

Example usage of the course lessons client to list lessons for a course and mark one as completed. Uses client.courseLessons.list and client.courseLessons.markAsCompleted.

```typescript
const lessons = await client.courseLessons.list({ course_id: "course_xxx" });
for await (const lesson of lessons) console.log(lesson.id, lesson.title);
await client.courseLessons.markAsCompleted({ lessonId: "lesson_xxx" });
```
Tokens:
Raw