Whop Python API Library

https://github.com/whopio/whopsdk-python
Admin
The Whop Python library provides convenient, type-safe access to the Whop REST API from any Python...
Tokens:404,291
Snippets:3,430
Trust Score:9.1
License:Apache-2.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Create setup intent with client.setup_intents.create()

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

Saves a buyer's payment method for later without charging it. The setup completes in the background, so the response is the setup intent as created, not its outcome. The example shows the required client initialization and the method call with an `account_id` parameter.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.setup_intents.create(
    account_id="biz_xxxxxxxxxxxxxx",
)

```

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

### GET setup_intents / POST setup_intents / POST setup_intents/direct

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

Retrieves setup intents, creates a new setup intent, or creates a direct setup intent.

```APIDOC
## GET setup_intents / POST setup_intents / POST setup_intents/direct

### Description
Retrieves setup intents, creates a new setup intent, or creates a direct setup intent.

### Method
GET, POST

### Endpoint
setup_intents, setup_intents/direct

### Response
#### Success Response
- **SetupIntent** (object) - The setup intent data.

```

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

### List setup intents with client.setup_intents.list()

Source: https://github.com/whopio/whopsdk-python/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`. The example shows the required client initialization and the method call with no arguments.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.setup_intents.list()

```

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

### GET /setup_intents

Source: https://github.com/whopio/whopsdk-python/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`.

```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`.

### Method
GET

### Endpoint
/setup_intents

### Parameters
#### Query Parameters
- **account_id** (string) - Optional - Only setup intents for this account, prefixed `biz_`.
- **status** (enum) - Optional - Only setup intents in this state.
- **created_before** (datetime) - Optional - Only setup intents created before this ISO 8601 timestamp.
- **created_after** (datetime) - Optional - Only setup intents created after this ISO 8601 timestamp.
- **order** (enum) - Optional - The field to sort by.
- **direction** (enum) - Optional - The sort direction.
- **first** (integer) - Optional - Number of results to return from the start of the range.
- **after** (string) - Optional - Return results after this cursor. Use `page_info.end_cursor` from the previous response to fetch the next page.
- **last** (integer) - Optional - Number of results to return from the end of the range.
- **before** (string) - Optional - Return results before this cursor. Use `page_info.start_cursor` from the previous response to fetch the previous page.

### Response
#### Success Response (200)
- **ListSetupIntentsResponse** - The response object containing the list of setup intents.

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

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

### Create an export using client.exports.create()

Source: https://github.com/whopio/whopsdk-python/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. The example creates an export for the 'ad_campaigns' resource.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.exports.create(
    resource="ad_campaigns",
)

```

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

### Use AsyncWhop with aiohttp

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

Shows how to use AsyncWhop with DefaultAioHttpClient as the httpx_client. This requires the aiohttp extra to be installed. The example lists products asynchronously.

```python
import asyncio

from whop_sdk import AsyncWhop, DefaultAioHttpClient


async def main() -> None:
    client = AsyncWhop(
        token="<token>",
        httpx_client=DefaultAioHttpClient(),
    )
    pager = await client.products.list(account_id="biz_xxxxxxxxxxxxxx")
    async for product in pager:
        print(product.id, product.title)


asyncio.run(main())
```

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

### GET /setup_intents/{id}

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

Retrieves a setup intent by its ID. Once the status is succeeded, the saved payment method can be charged.

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

### Description
Retrieves a setup intent. Once its `status` is `succeeded`, charge the saved method by its `payment_method_id`. The buyer's own token may retrieve a setup intent that belongs to it.

### Method
GET

### Endpoint
/setup_intents/{id}

### Parameters
#### Path Parameters
- **id** (`str`) - Required - The setup intent to retrieve, prefixed `sint_`.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (`str`) - The setup intent ID.
- **status** (`str`) - The status of the setup intent.
- **payment_method_id** (`str`) - The ID of the saved payment method.

#### Response Example
```json
{
  "id": "sint_123",
  "status": "succeeded",
  "payment_method_id": "payt_123"
}
```
```

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

### create account example

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

Example call to `client.accounts.create` with `title`, `email`, `country`, and `metadata` parameters.

```python
account = client.accounts.create(
    title="My Store",
    email="owner@example.com",
    country="US",
    metadata={"plan": "pro"},
)
```

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

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

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

Retrieves a setup intent. Once its status is succeeded, charge the saved method by its payment_method_id. The buyer's own token may retrieve a setup intent that belongs to it.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.setup_intents.retrieve(
    id="id",
)

```

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

### POST /setup_intents

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

Saves a buyer's payment method for later without charging it — one the buyer just supplied through the payment elements in setup mode, or one already on file to re-verify. The setup completes in the background, so the response is the setup intent as created, not its outcome: 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 — one the buyer just supplied through the payment elements in setup mode, or one already on file to re-verify. The setup completes in the background, so the response is the setup intent as created, not its outcome: 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, prefixed `biz_`.

### Response
#### Success Response (200)
- **SetupIntent** - The created setup intent object.

### Response Example
```json
{
  "id": "seti_...",
  "client_secret": "..."
}
```
```

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

### Form Company Accounts Request Example

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

Starts an LLC or C-Corp formation for a business account. The application is validated and the response returns a hosted checkout URL; once paid, the filing is submitted. Track progress through the account's company_formation field on Retrieve Account.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment
from whop_sdk.accounts import FormCompanyAccountsRequestBusinessAddress, FormCompanyAccountsRequestFoundersItem, FormCompanyAccountsRequestFoundersItemAddress, FormCompanyAccountsRequestShareStructure

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.accounts.form_company(
    id="id",
    business_address=FormCompanyAccountsRequestBusinessAddress(
        city="Austin",
        country="US",
        line1="4180 Burnet Rd",
        line2="Suite 2",
        postal_code="78756",
        state="TX",
    ),
    business_name="Shine Time Auto Detailing",
    business_phone="+15125550142",
    business_website="https://shinetime.example",
    entity_suffix="LLC",
    entity_type="llc",
    expedite_ein=True,
    formation_state="WY",
    founders=[
        FormCompanyAccountsRequestFoundersItem(
            address=FormCompanyAccountsRequestFoundersItemAddress(
                city="Austin",
                country="US",
                line1="907 Ridgemont Dr",
                line2="Apt 4",
                postal_code="78704",
                state="TX",
            ),
            date_of_birth="1988-03-14",
            email="marcus@shinetime.example",
            first_name="Marcus",
            is_primary=True,
            last_name="Webb",
            ownership_percentage=100,
            phone="+15125550142",
            roles=[
                "president"
            ],
            ssn="123-45-6789",
        )
    ],
    share_structure=FormCompanyAccountsRequestShareStructure(
        number_of_shares=123,
        value=123,
    ),
    use_registered_agent=True,
)

```

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

### Create webhook example

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

Example usage of the `create` method. It creates a webhook with a destination URL, subscribed events, and a resource ID, then prints the webhook ID and secret from the response.

```python
webhook = client.webhooks.create(
    url="https://example.com/whop",
    events=["payment.succeeded", "membership.activated"],
    resource_id="biz_123",
)
print(webhook.id, webhook.webhook_secret)
```

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

### Validate Whop pixel installation with client.events.validate_pixel()

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

Checks whether the Whop pixel is installed for an account or a specific page when a `url` is provided. Use before launching an ad to confirm tracking, or in a setup flow to verify installation. The `account_id` parameter defaults to the authenticated account.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.events.validate_pixel()

```

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

### POST /setup_intents

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

Creates a setup intent to save a payment method for a buyer. Provide either a confirmation_token or a payment_method_id.

```APIDOC
## [POST] /setup_intents

### Description
Creates a setup intent to save a payment method for a buyer. Provide either a `confirmation_token` or a `payment_method_id`.

### Method
POST

### Endpoint
/setup_intents

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **account_id** (`str`) - Required - The account to save the payment method for, prefixed `biz_`.
- **confirmation_token** (`typing.Optional[str]`) - Optional - A confirmation token describing a payment method the buyer just supplied, collected by the payment elements in setup mode. Provide this or `payment_method_id`, not both.
- **currency** (`typing.Optional[str]`) - Optional - The currency the saved payment method will be used with, as a lowercase ISO 4217 code. Defaults to `usd`.
- **email** (`typing.Optional[str]`) - Optional - Overrides the buyer email carried on the confirmation token, resolving or creating the user the method belongs to.
- **metadata** (`typing.Optional[typing.Dict[str, typing.Optional[str]]]`) - Optional - Custom metadata to attach to the setup intent.
- **payment_method_id** (`typing.Optional[str]`) - Optional - An existing payment method to re-verify and save, prefixed `payt_`. Provide this or `confirmation_token`, not both.
- **purpose** (`typing.Optional[CreateSetupIntentsRequestPurpose]`) - Optional - What the saved payment method will pay for. Set to `ads_billing` when saving a card to pay for Whop Ads.
- **return_url** (`typing.Optional[str]`) - Optional - Where the buyer continues after completing an off-site step.
- **three_ds_level** (`typing.Optional[CreateSetupIntentsRequestThreeDsLevel]`) - Optional - 3D Secure behavior for supported on-session card payments.
- **request_options** (`typing.Optional[RequestOptions]`) - Optional - Request-specific configuration.

### Request Example
```json
{
  "account_id": "biz_123",
  "confirmation_token": "ct_123",
  "currency": "usd",
  "email": "buyer@example.com",
  "metadata": {"key": "value"},
  "payment_method_id": "payt_123",
  "purpose": "ads_billing",
  "return_url": "https://example.com/return",
  "three_ds_level": "frictionless_if_required"
}
```

### Response
#### Success Response (200)
- **id** (`str`) - The setup intent ID, prefixed `sint_`.
- **status** (`str`) - The status of the setup intent.
- **payment_method_id** (`str`) - The ID of the saved payment method, prefixed `payt_`.
- **client_secret** (`str`) - The client secret for the setup intent.

#### Response Example
```json
{
  "id": "sint_123",
  "status": "succeeded",
  "payment_method_id": "payt_123",
  "client_secret": "cs_123"
}
```
```

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

### Create a plan with client.plans.create

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

Creates a new plan using the Whop SDK. The example shows client initialization with a token and production environment, then calls client.plans.create with no arguments. All parameters are optional and include account_id, adaptive_pricing_enabled, attributes, billing_period, checkout_styling, currency, custom_fields, description, expiration_days, image, initial_price, internal_notes, metadata, override_tax_type, payment_method_configuration, plan_type, product_id, release_method, renewal_price, sku, split_pay_required_payments, stock, three_ds_level, title, trial_period_days, unlimited_stock, visibility, and request_options.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.plans.create(
)

```

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

### retrieve usage example

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

Example call to `client.stats.retrieve` with the required `metric` and date range, plus an `interval` of "day". This method is deprecated; use `GET /stats/time_series/{metric}` instead.

```python
series = client.stats.retrieve("net_revenue", from_="2026-01-01", to="2026-02-01", interval="day")
```

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

### client.events.validate_pixel()

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

Checks whether the Whop pixel is installed for an account, or on one page when a url is passed. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live.

```APIDOC
## client.events.validate_pixel()

### Description
Checks whether the Whop pixel is installed for an account, or on one page when you pass a `url`. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live.

### Method
SDK Method

### Endpoint
`client.events.validate_pixel()`

### Parameters
#### Optional Parameters
- **account_id** (`typing.Optional[str]`) - Optional - Account to check. Defaults to the authenticated account.
- **url** (`typing.Optional[str]`) - Optional - A page to check for the pixel, such as an ad destination. Events from that page settle the answer; if it hasn't sent any lately, it is fetched and its source read for the pixel and the conversion events wired on it. Omit it to check the account from its events alone.
- **request_options** (`typing.Optional[RequestOptions]`) - Optional - Request-specific configuration.

### Request Example
```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.events.validate_pixel()
```

### Response
#### Success Response (200)
- **response** - The result of the pixel validation check.

```

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

### POST /v1/setup-intents/direct

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

Creates a setup intent for saving a card directly from raw card details, intended for PCI-compliant integrators. The operation is routed to the vault host for tokenization, and the setup runs asynchronously.

```APIDOC
## [POST] /v1/setup-intents/direct

### Description
Saves a card for later charges from card details you hold yourself, for integrators whose own systems are PCI compliant. Send this operation to the vault host, which tokenizes the card before it reaches Whop; the official SDKs route it there, and raw card details sent to the regular host are refused. 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
/v1/setup-intents/direct

### Parameters
#### Request Body
- **account_id** (string) - Required - The account the card is saved for, prefixed `biz_`.
- **billing_details** (object) - Required - The buyer's billing details.
- **payment_method** (object) - Required - The payment method to save, as the raw details the caller holds. Raw details are accepted only on the vault host, where Whop's vault tokenizes them in transit; the official SDKs route this operation there. Whop's own clients, which tokenize with the Basis Theory SDK, send the resulting token intent id to the regular host.
- **currency** (string) - Optional - The currency the card will be charged in, as a three-letter code. Defaults to usd.
- **member_id** (string) - Optional - The member the card belongs to, prefixed `mber_`. When omitted the buyer is resolved from `billing_details.email`.
- **metadata** (object) - Optional - Custom metadata to attach to the setup.
- **return_url** (string) - Optional - Where the buyer continues after completing an off-site step such as 3D Secure. An absolute https URL without credentials, at most 2,048 characters.
- **request_options** (object) - Optional - Request-specific configuration.

### Request Example
```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment
from whop_sdk.setup_intents.direct import CreateDirectRequestBillingDetails, CreateDirectRequestBillingDetailsAddress, CreateDirectRequestPaymentMethod

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.setup_intents.direct.create(
    account_id="biz_xxxxxxxxxxxxxx",
    billing_details=CreateDirectRequestBillingDetails(
        address=CreateDirectRequestBillingDetailsAddress(
            country="US",
            postal_code="94105",
        ),
        email="dana@shinetime.example",
        name="Dana Shine",
    ),
    payment_method=CreateDirectRequestPaymentMethod(
        type="card",
    ),
)
```

### Response
#### Success Response (200)
- **SetupIntent** (object) - The created setup intent.

#### Response Example
```json
{
  "id": "seti_xxxxxxxxxxxxxx",
  "status": "requires_action"
}
```
```

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

### create usage example

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

Shows how to call `client.products.create` with an account ID, title, description, headline, and metadata. The `title` is required; other fields are optional.

```python
product = client.products.create(
    account_id="biz_123",
    title="Digital Course",
    description="A video course about Python",
    headline="Learn Python fast",
    metadata={"sku": "PY-101"},
)
```

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

### Create a setup intent with Whop SDK

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

Initializes the Whop client with a token and production environment, then calls client.setup_intents.create with a setup_intent_id and return_url. The return_url must be an absolute https URL without credentials (http allowed for localhost), at most 2,048 characters.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.setup_intents.create(
    setup_intent_id="setup_intent_id",
    return_url="https://example.com",
)

```

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

### Summary resolution center cases

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

Aggregates the same cases as GET /resolution_center_cases using the same filters. Use it to build status tabs and issue filters without paging the whole list. The example shows the client call with no parameters.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.resolution_center_cases.summary()

```

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

### Async example

Source: https://github.com/whopio/whopsdk-python/blob/main/_autodocs/api-reference/access-tokens.md

Asynchronously creates an access token using AsyncWhop.

```python
import asyncio
from whop_sdk import AsyncWhop

client = AsyncWhop(token="<token>")


async def main() -> None:
    at = await client.access_tokens.create(account_id="biz_123")
    print(at.token)


asyncio.run(main())
```

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

### Create a domain with client.domains.create

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

Creates a new domain. The domain parameter must be a bare hostname (e.g., example.com) without wildcards, paths, schemes, or ports. Optional parameters include account_id, metadata, pixel, registration, verification, and website.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.domains.create(
    domain="store.example.com",
)

```

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

### POST /media/generate

Source: https://github.com/whopio/whopsdk-python/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
## POST /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** (str) - Required - What to generate. Up to 2,000 characters.
- **type** (GenerateMediaRequestType) - Required - The kind of media to generate.
- **account_id** (str) - Optional - Account ID, prefixed biz_. Defaults to the account the API key belongs to.
- **duration_seconds** (int) - Optional - Video length in seconds. Video only; defaults to 5.
- **reference_media** (List[str]) - Optional - Optional reference image file IDs (file_ prefixed), up to 4. For video, a single reference seeds the opening frame; multiple references guide subject and style instead.
- **resolution** (GenerateMediaRequestResolution) - Optional - Video resolution. Video only; defaults to 1080p. 1080p is not supported by Seedance 2.0 Fast or Mini; 4k is only supported by Seedance 2.0.
- **request_options** (RequestOptions) - Optional - Request-specific configuration.

### Response
#### Success Response (200)
- **MediaAsset** - The generated media asset.

```

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

### Create an app with client.apps.create

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

Registers a new app on the Whop developer platform. The example initializes a Whop client with a token and production environment, then calls client.apps.create with a name. The name parameter is required; other parameters like account_id, app_type, base_url, domain_id, icon, imported_from_url, redirect_uris, route, and request_options are optional.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.apps.create(
    name="Shine Time Booking",
)

```

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

### Create an experience with client.experiences.create()

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

Creates an experience for an account, powered by an app such as courses, forums, or chat. Requires the `experience:create` permission. Attach the experience to a product with `POST /experiences/:id/attach` to grant product customers access.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.experiences.create(
    account_id="biz_xxxxxxxxxxxxxx",
    app_id="app_xxxxxxxxxxxxxx",
)

```

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

### Retrieve financial report breakdown with client.financial_reports.breakdown.retrieve

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

Use this snippet to call the breakdown retrieve method, which explains a total from GET /financial_reports by breaking a bucket into top contributors. It requires an account_id, bucket, direction, currency, and ISO 8601 from/to timestamps. The example uses the production environment and a placeholder token.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment
import datetime

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.financial_reports.breakdown.retrieve(
    account_id="account_id",
    bucket="transfers",
    direction="money_in",
    currency="currency",
    from_=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
    to=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
)

```

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

### Install dependencies with poetry install

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

Installs the project dependencies using Poetry. Requires Python 3.9+, pip, and poetry.

```bash
poetry install
```

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

### List products with products.list

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

Shows how to create a Whop client and iterate over paginated products using the products.list method. Requires a valid token and an account ID.

```python
from whop_sdk import Whop

client = Whop(token="<token>")

for product in client.products.list(account_id="biz_xxxxxxxxxxxxxx"):
    print(product.id, product.title)
```

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

### delete usage example

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

Example of deleting a webhook by ID.

```python
resp = client.webhooks.delete("hook_123")
```

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

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

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

Creates a new course within an experience, with optional chapters, lessons, and a certificate. Requires `courses:update` permission.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.courses.create(
    experience_id="exp_xxxxxxxxxxxxxx",
    title="title",
)

```

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

### retrieve usage example

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

Example of retrieving a webhook by ID.

```python
wh = client.webhooks.retrieve("hook_123")
```

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

### Create a SetupIntent Direct with Whop SDK

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

Use this snippet to save a card for later charges from card details you hold yourself. The operation is routed to the vault host, which tokenizes the card before it reaches Whop. The setup runs in the background; poll Retrieve setup status for the outcome and any buyer actions like 3D Secure. On success, the saved payment method appears on the `setup_intent.succeeded` webhook and in List payment methods.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment
from whop_sdk.setup_intents.direct import CreateDirectRequestBillingDetails, CreateDirectRequestBillingDetailsAddress, CreateDirectRequestPaymentMethod

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.setup_intents.direct.create(
    account_id="biz_xxxxxxxxxxxxxx",
    billing_details=CreateDirectRequestBillingDetails(
        address=CreateDirectRequestBillingDetailsAddress(
            country="US",
            postal_code="94105",
        ),
        email="dana@shinetime.example",
        name="Dana Shine",
    ),
    payment_method=CreateDirectRequestPaymentMethod(
        type="card",
    ),
)

```

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

### me account example

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

Example call to `client.accounts.me()` to retrieve the current account.

```python
account = client.accounts.me()
```

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

### Create account using client.accounts.create()

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

Creates an account. User tokens create business accounts; Account API keys create connected accounts. Tax fields are configured with Update Account, not at creation. The example initializes the Whop client and calls `client.accounts.create()`.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.accounts.create()

```

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

### Create API key - usage example

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

Example of creating an API key for an account with permissions for products and payments, and an IP allowlist. The `secret_key` is printed and must be stored immediately because it is only returned in this response.

```python
key = client.api_keys.create(
    name="ci-bot",
    resource_id="biz_123",
    resource_type="account",
    permissions={"products": ["read", "write"], "payments": ["read"]},
    ip_allowlist=["203.0.113.0/24"],
)
print(key.secret_key)  # only place it is returned; store immediately
```

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

### list_deliveries usage example

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

Example of iterating over delivery attempts for a webhook.

```python
for d in client.webhooks.list_deliveries("hook_123"):
    print(d.id, d.event)
```

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

### Instantiate ProductsClient

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

Creates a Whop client and accesses the products sub-client. Requires a valid token.

```python
client = Whop(token="<token>").products
```

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

### Create product with client.products.create()

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

Creates a new product for an account. The example shows creating a product with a title.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.products.create(
    title="Interior Deep Clean",
)

```

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

### transfer_ownership usage example

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

Example call to `transfer_ownership` with an account ID and recipient identifier.

```python
resp = client.accounts.transfer_ownership("biz_123", identifier="user_789")

```

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

### test usage example

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

Example call to test with a webhook ID and event name.

```python
result = client.webhooks.test("hook_123", event="payment.succeeded")
```

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

### replay_delivery usage example

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

Example call to replay_delivery with a webhook ID and delivery ID.

```python
result = client.webhooks.replay_delivery("hook_123", "dlv_456")
```

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

### update usage example

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

Example of updating a webhook's URL and enabled state.

```python
wh = client.webhooks.update("hook_123", url="https://example.com/new", enabled=True)
```

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

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

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

Updates the return URL for a setup intent, allowing the buyer to be redirected to a different destination after completing an off-site step.

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

### Description
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`.

### Method
POST

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

### Parameters
#### Path Parameters
- **setup_intent_id** (`str`) - Required - The ID of the setup intent.

#### Query Parameters
None

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

### Request Example
```json
{
  "return_url": "https://shinetime.example/checkout/thanks"
}
```

### Response
#### Success Response (200)
- **return_url** (`str`) - The updated return URL.

#### Response Example
```json
{
  "return_url": "https://shinetime.example/checkout/thanks"
}
```
```

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

### check_access usage example

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

Example call to `client.users.check_access` with a user id and resource id.

```python
access = client.users.check_access("user_123", "prod_456")
```

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

### update example call

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

Example call to update a membership, setting billing_period_days and metadata.

```python
client.memberships.update("mem_123", billing_period_days=30, metadata={"note": "vip"})
```

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

### Create verification using client.verifications.create()

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

Starts a hosted verification session for an account or user, or returns the active session if one exists. Send documents, share_token, or verification_id to skip the hosted session. Once approved, only verification_id reuse is allowed; unlink first to start a new one.

```python
from whop_sdk import Whop
from whop_sdk.environment import WhopEnvironment
from whop_sdk.verifications import CreateVerificationsRequestBody_Individual

client = Whop(
    token="<token>",
    environment=WhopEnvironment.PRODUCTION,
)

client.verifications.create(
    request=CreateVerificationsRequestBody_Individual(),
)

```
Tokens:
Raw