> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Whop

> Making everyone an internet entrepreneur. Explore a playground for digital products, memberships & communities.

![Whop logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/whop.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=9088ed4b1f2a43450036ab97b9e5ba41)

* **Category:** ecommerce
* **Auth:** API\_KEY, OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 35
* **Triggers:** 0
* **Slug:** `WHOP`
* **Version:** 20261101\_00

## Tools

> [accordion] Attach Experience
>
> **Slug:** `WHOP_ATTACH_EXPERIENCE`
>
> Attach an experience to a product so its customers gain access.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the experience to attach.
>
> **product\_id** `string` *required*
>
> The unique identifier of the product that should grant access to the experience.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Permissions
>
> **Slug:** `WHOP_CHECK_PERMISSIONS`
>
> Check which permission actions the caller has on a Whop resource.
>
> #### Input Parameters
>
> **actions** `array`
>
> Permission actions to check. Omit to return every permission action.
>
> **resource\_id** `string` *required*
>
> The account, product, experience, or app resource identifier to check.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Access Token
>
> **Slug:** `WHOP_CREATE_ACCESS_TOKEN`
>
> Create a short-lived access token for authenticating API requests, including Whop's web and mobile embedded components. Provide either a company ID or a user ID, but not both.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User identifier. Required when using API key authentication. Cannot be used together with company\_id.
>
> **company\_id** `string`
>
> Business identifier. Required when using API key authentication. Cannot be used together with user\_id.
>
> **expires\_at** `string`
>
> Token expiration timestamp in ISO 8601 format (defaults to 1 hour, max 3 hours from now).
>
> **scoped\_actions** `array`
>
> Permission scopes to grant to the access token. If empty or omitted, all permissions from the authenticating credential are inherited. Must be a subset of the credential's permissions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Experience
>
> **Slug:** `WHOP_CREATE_EXPERIENCE`
>
> Create an app-powered experience for a Whop account.
>
> #### Input Parameters
>
> **name** `string`
>
> The display name of the experience. Defaults to the app name when omitted.
>
> **app\_id** `string` *required*
>
> The unique identifier of the app that powers the experience.
>
> **logo\_id** `string`
>
> The unique identifier of the file to use as the experience logo.
>
> **is\_public** `boolean`
>
> Whether the experience is publicly accessible without a membership.
>
> **account\_id** `string` *required*
>
> The unique identifier of the Whop account that will own the experience.
>
> **section\_id** `string`
>
> The unique identifier of the section in which to place the experience.
>
> **notifications\_enabled** `boolean`
>
> Whether Whop app notifications are enabled for the experience. Webhooks still fire when disabled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create file
>
> **Slug:** `WHOP_CREATE_FILE`
>
> Tool to create a new file record and receive a presigned URL for uploading content to S3. Use when you need to upload files to Whop.
>
> #### Input Parameters
>
> **filename** `string` *required*
>
> The name of the file including its extension (e.g., 'photo.png' or 'document.pdf').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Product
>
> **Slug:** `WHOP_CREATE_PRODUCT`
>
> Create a Whop digital product for an account.
>
> #### Input Parameters
>
> **route** `string`
>
> The URL slug used in the product's public link.
>
> **title** `string` *required*
>
> The display name of the product.
>
> **labels** `array`
>
> Labels used to group products into collections. Whop stores them lowercased and de-duplicated.
>
> **headline** `string`
>
> A short marketing headline displayed prominently on the product page.
>
> **metadata** `object`
>
> Custom key-value metadata included in payment and membership webhooks.
>
> **account\_id** `string`
>
> The account that will own the product. Omit it when the credential supplies the account.
>
> **custom\_cta** `string ("get_access" | "join" | "order_now" | "shop_now" | "call_now" | "donate_now" | "contact_us" | "sign_up" | "subscribe" | "purchase" | "get_offer" | "apply_now" | "complete_order")`
>
> Call-to-action labels supported by Whop products.
>
> **visibility** `string`
>
> Whether and how the product is visible to customers.
>
> **description** `string`
>
> A written description displayed on the product page.
>
> **custom\_cta\_url** `string`
>
> A URL opened by the call-to-action instead of the default checkout flow.
>
> **gallery\_images** `array`
>
> Images or videos displayed in the product gallery, in display order. Send an empty array to clear it.
>
> **idempotency\_key** `string`
>
> A unique key sent as Idempotency-Key to make retries safe.
>
> **product\_tax\_code\_id** `string`
>
> The unique identifier of the tax classification code for the product.
>
> **send\_welcome\_message** `boolean`
>
> Whether to send an automated support-chat welcome message when a user joins.
>
> **redirect\_purchase\_url** `string`
>
> The URL to redirect a customer to after a completed purchase.
>
> **global\_affiliate\_status** `string ("enabled" | "disabled")`
>
> Product affiliate program enrollment states.
>
> **member\_affiliate\_status** `string ("enabled" | "disabled")`
>
> Product affiliate program enrollment states.
>
> **collect\_shipping\_address** `boolean`
>
> Whether checkout collects the customer's shipping address.
>
> **custom\_statement\_descriptor** `string`
>
> Custom bank statement descriptor. Must start with WHOP\*.
>
> **global\_affiliate\_percentage** `number`
>
> Commission percentage earned through the global affiliate program.
>
> **member\_affiliate\_percentage** `number`
>
> Commission percentage earned by members through referrals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Variant
>
> **Slug:** `WHOP_CREATE_VARIANT`
>
> Create a product-backed or standalone purchasable Whop pricing variant.
>
> #### Input Parameters
>
> **sku** `string`
>
> A seller-defined stock keeping unit; it need not be unique.
>
> **image** `object`
>
> Image reference accepted when creating a variant.
>
> **stock** `integer`
>
> The maximum units available for purchase when stock is limited.
>
> **title** `string`
>
> The customer-facing display name of the variant.
>
> **currency** `string`
>
> The three-letter ISO currency code for pricing. Whop defaults to usd.
>
> **metadata** `object`
>
> Custom key-value pairs stored on the variant.
>
> **plan\_type** `string`
>
> The variant billing type.
>
> **account\_id** `string`
>
> The account that will own the variant. Required when authenticating as a user; an account API key supplies its own account.
>
> **attributes** `object`
>
> Attribute names and values that distinguish this variant.
>
> **product\_id** `string`
>
> The product to attach this variant to. Omit it for a standalone variant.
>
> **visibility** `string ("visible" | "hidden" | "archived" | "quick_link")`
>
> Visibility options for a Whop variant.
>
> **description** `string`
>
> A customer-facing description of the variant.
>
> **custom\_fields** `array`
>
> Custom fields to collect from customers at checkout.
>
> **initial\_price** `number`
>
> The initial amount charged in the variant's currency. Use 0 for a free variant.
>
> **renewal\_price** `number`
>
> The amount charged each billing period for a recurring variant.
>
> **billing\_period** `integer`
>
> The recurring billing interval in days, such as 30 for monthly billing.
>
> **internal\_notes** `string`
>
> Private notes visible only to the account owner.
>
> **release\_method** `string`
>
> The sales method for this variant.
>
> **three\_ds\_level** `string ("mandate_challenge" | "mandate_if_required" | "frictionless_if_required")`
>
> 3D Secure preferences accepted for a variant.
>
> **expiration\_days** `integer`
>
> The number of days before access through this variant expires.
>
> **idempotency\_key** `string`
>
> A unique key sent as Idempotency-Key to make retries safe.
>
> **unlimited\_stock** `boolean`
>
> Whether the variant has unlimited stock. When true, stock is ignored.
>
> **checkout\_styling** `object`
>
> Checkout styling overrides for this variant.
>
> **override\_tax\_type** `string`
>
> A tax classification override for this variant.
>
> **trial\_period\_days** `integer`
>
> The number of free trial days before the first recurring charge.
>
> **adaptive\_pricing\_enabled** `boolean`
>
> Whether this variant accepts adaptive local-currency pricing.
>
> **split\_pay\_required\_payments** `integer`
>
> Installments required before a split-pay subscription pauses.
>
> **payment\_method\_configuration** `object`
>
> Payment overrides requiring at least one of enabled or disabled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Experience
>
> **Slug:** `WHOP_DELETE_EXPERIENCE`
>
> Permanently delete an experience and detach it from every product.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the experience to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Promo Code
>
> **Slug:** `WHOP_DELETE_PROMO_CODE`
>
> Tool to archive a promo code, preventing it from being used in future checkouts. Use when you need to deactivate or remove a promo code from circulation. Existing memberships created with this promo code are not affected by archiving. The operation changes the promo code status from 'active' to 'archived'.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the promo code to archive. Format: promo\_xxxxxxxxxxxx
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detach Experience
>
> **Slug:** `WHOP_DETACH_EXPERIENCE`
>
> Detach an experience from a product, removing access through that product.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the experience to detach.
>
> **product\_id** `string` *required*
>
> The unique identifier of the product that should no longer grant access to the experience.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Apps
>
> **Slug:** `WHOP_LIST_APPS`
>
> Tool to retrieve a paginated list of apps on the Whop platform. Use when you need to browse or search for apps with optional filtering by company, type, verification status, or view support. Supports cursor-based pagination.
>
> #### Input Parameters
>
> **last** `integer`
>
> Returns the last n elements from the list
>
> **after** `string`
>
> Returns the elements in the list that come after the specified cursor
>
> **first** `integer`
>
> Returns the first n elements from the list
>
> **order** `string ("discoverable_at" | "created_at" | "total_installs_last_30_days" | "total_installs_last_7_days" | "time_spent" | "time_spent_last_24_hours" | "daily_active_users" | "ai_prompt_count" | "total_ai_cost_usd" | "total_ai_tokens" | "last_ai_prompt_at" | "ai_average_rating")`
>
> Field to sort apps by.
>
> **query** `string`
>
> A search string to filter apps by name
>
> **before** `string`
>
> Returns the elements in the list that come before the specified cursor
>
> **app\_type** `string ("b2b_app" | "b2c_app" | "company_app" | "component")`
>
> Audience type for apps.
>
> **direction** `string ("asc" | "desc")`
>
> Sort direction for results.
>
> **view\_type** `string ("hub" | "discover" | "dash" | "dashboard" | "analytics")`
>
> View types supported by apps.
>
> **company\_id** `string`
>
> Filter apps to only those created by this company (format: biz\_\*)
>
> **verified\_apps\_only** `boolean`
>
> Whether to only return apps that have been verified by Whop
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Authorized Users
>
> **Slug:** `WHOP_LIST_AUTHORIZED_USERS`
>
> Tool to retrieve a paginated list of authorized team members for a company. Use when you need to view company team members, check user permissions, or audit team access. Supports filtering by company, user, role, and creation date with cursor-based pagination.
>
> #### Input Parameters
>
> **last** `integer`
>
> Returns the last n elements from the list. Cannot be used with 'first'
>
> **role** `string ("owner" | "admin" | "sales_manager" | "moderator" | "app_manager" | "support" | "manager")`
>
> Enum for authorized user roles within a company.
>
> **after** `string`
>
> Returns the elements in the list that come after the specified cursor. Used for forward pagination
>
> **first** `integer`
>
> Returns the first n elements from the list. Cannot be used with 'last'
>
> **before** `string`
>
> Returns the elements in the list that come before the specified cursor. Used for backward pagination
>
> **user\_id** `string`
>
> Filter results to a specific user to check if they are an authorized team member
>
> **company\_id** `string`
>
> The unique identifier of the company to filter authorized users by (e.g., biz\_xxxxxxxxxxxxxx)
>
> **created\_after** `string`
>
> Only return authorized users created after this timestamp (ISO 8601 date-time format)
>
> **created\_before** `string`
>
> Only return authorized users created before this timestamp (ISO 8601 date-time format)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Members
>
> **Slug:** `WHOP_LIST_MEMBERS`
>
> Tool to retrieve a paginated list of members for a company. Use when you need to view company members with optional filtering by product, plan, status, access level, and more. Supports cursor-based pagination and searching by name, username, or email.
>
> #### Input Parameters
>
> **last** `integer`
>
> Returns the last n elements from the list
>
> **after** `string`
>
> Returns the elements in the list that come after the specified cursor
>
> **first** `integer`
>
> Returns the first n elements from the list
>
> **order** `string ("id" | "usd_total_spent" | "created_at" | "joined_at" | "most_recent_action")`
>
> Sort order field values.
>
> **query** `string`
>
> Search members by name, username, or email
>
> **before** `string`
>
> Returns the elements in the list that come before the specified cursor
>
> **plan\_ids** `array`
>
> Filter by specific plan identifiers
>
> **statuses** `array`
>
> Filter by member status: drafted, joined, or left
>
> **user\_ids** `array`
>
> Filter by specific user identifiers
>
> **direction** `string ("asc" | "desc")`
>
> Sort direction values.
>
> **company\_id** `string`
>
> Company identifier to list members for. If omitted, defaults to the company associated with the API key.
>
> **product\_ids** `array`
>
> Filter by specific product identifiers
>
> **access\_level** `string ("no_access" | "admin" | "customer")`
>
> Access level a user or company has to a product or company.
>
> **created\_after** `string`
>
> Filter members created after this timestamp (ISO 8601 date-time)
>
> **created\_before** `string`
>
> Filter members created before this timestamp (ISO 8601 date-time)
>
> **promo\_code\_ids** `array`
>
> Filter by promo codes used
>
> **most\_recent\_actions** `array`
>
> Filter by recent activity types
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List memberships
>
> **Slug:** `WHOP_LIST_MEMBERSHIPS`
>
> Tool to retrieve a paginated list of memberships with filtering options. Use when you need to list memberships by product, plan, status, user, or promo code.
>
> #### Input Parameters
>
> **last** `integer`
>
> Returns the last n elements from the list. Use for backward pagination.
>
> **after** `string`
>
> Pagination cursor that returns elements in the list after the specified cursor. Use this to fetch the next page of results.
>
> **first** `integer`
>
> Returns the first n elements from the list. Use for forward pagination.
>
> **order** `string ("id" | "created_at" | "status" | "canceled_at" | "date_joined" | "total_spend")`
>
> Order by field enum.
>
> **before** `string`
>
> Pagination cursor that returns elements in the list before the specified cursor. Use this to fetch the previous page of results.
>
> **plan\_ids** `array`
>
> Filter to only include memberships belonging to these plan identifiers. Pass multiple plan IDs to filter by multiple plans.
>
> **statuses** `array`
>
> Filter memberships by their current status. Can include multiple statuses to match any of them.
>
> **user\_ids** `array`
>
> Filter to only include memberships belonging to these user identifiers. Pass multiple user IDs to filter by multiple users.
>
> **direction** `string ("asc" | "desc")`
>
> Sort direction enum.
>
> **company\_id** `string`
>
> The unique identifier of the company to list memberships for. Required when using an API key authentication.
>
> **product\_ids** `array`
>
> Filter to only include memberships belonging to these product identifiers. Pass multiple product IDs to filter by multiple products.
>
> **created\_after** `string`
>
> Only return memberships created after this timestamp. Use ISO 8601 format.
>
> **cancel\_options** `array`
>
> Filter to only include memberships matching these cancellation reasons. Only applicable to canceled memberships.
>
> **created\_before** `string`
>
> Only return memberships created before this timestamp. Use ISO 8601 format.
>
> **promo\_code\_ids** `array`
>
> Filter to only include memberships that used these promo code identifiers during checkout.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Messages
>
> **Slug:** `WHOP_LIST_MESSAGES`
>
> List messages in an experience chat, DM, or group chat channel.
>
> #### Input Parameters
>
> **last** `integer`
>
> Return the last n messages from the selected page.
>
> **after** `string`
>
> Return messages after this cursor for forward pagination.
>
> **first** `integer`
>
> Return the first n messages from the selected page.
>
> **before** `string`
>
> Return messages before this cursor for backward pagination.
>
> **direction** `string ("asc" | "desc")`
>
> Sort directions supported for messages.
>
> **channel\_id** `string` *required*
>
> The unique identifier of the channel or experience to list messages for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payment Fees
>
> **Slug:** `WHOP_LIST_PAYMENT_FEES`
>
> Return the complete fee breakdown for one Whop payment.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The payment whose fees to list, prefixed pay\_.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payment Methods
>
> **Slug:** `WHOP_LIST_PAYMENT_METHODS`
>
> Tool to retrieve a paginated list of payment methods for a member or company. Use when you need to view stored payment information such as cards, bank accounts, or digital wallets. Either member\_id or company\_id must be provided.
>
> #### Input Parameters
>
> **last** `integer`
>
> Returns the last n elements from the list. Cannot be used with 'first' parameter.
>
> **after** `string`
>
> Cursor for paginating forward through results. Use the end\_cursor from the previous response.
>
> **first** `integer`
>
> Returns the first n elements from the list. Cannot be used with 'last' parameter.
>
> **before** `string`
>
> Cursor for paginating backward through results. Use the start\_cursor from the previous response.
>
> **direction** `string ("asc" | "desc")`
>
> Sort direction for pagination.
>
> **member\_id** `string`
>
> The unique identifier of the member. Either member\_id or company\_id must be provided.
>
> **company\_id** `string`
>
> The unique identifier of the company. Either member\_id or company\_id must be provided.
>
> **created\_after** `string`
>
> Filter to payment methods created after this ISO 8601 timestamp.
>
> **created\_before** `string`
>
> Filter to payment methods created before this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payments
>
> **Slug:** `WHOP_LIST_PAYMENTS`
>
> Tool to retrieve a paginated list of payments for a company. Use when you need to view payment history with optional filtering by product, plan, status, billing reason, currency, and creation date. Supports cursor-based pagination.
>
> #### Input Parameters
>
> **last** `integer`
>
> Returns the last n elements from the list
>
> **after** `string`
>
> Returns the elements in the list that come after the specified cursor
>
> **first** `integer`
>
> Returns the first n elements from the list
>
> **order** `string ("final_amount" | "created_at" | "paid_at")`
>
> Sort order field values.
>
> **before** `string`
>
> Returns the elements in the list that come before the specified cursor
>
> **plan\_ids** `array`
>
> Filter by specific plan identifiers
>
> **statuses** `array`
>
> Filter by payment status
>
> **direction** `string ("asc" | "desc")`
>
> Sort direction values.
>
> **company\_id** `string`
>
> The unique identifier of the company to list payments for. If omitted, defaults to the company associated with the API key.
>
> **currencies** `array`
>
> Filter by currency code (usd, eur, gbp, etc.)
>
> **product\_ids** `array`
>
> Filter by specific product identifiers
>
> **substatuses** `array`
>
> Filter by friendly status for granular filtering
>
> **include\_free** `boolean`
>
> Whether to include payments with a zero amount
>
> **created\_after** `string`
>
> Only return payments created after this timestamp (ISO 8601 date-time)
>
> **created\_before** `string`
>
> Only return payments created before this timestamp (ISO 8601 date-time)
>
> **billing\_reasons** `array`
>
> Filter by billing reason
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products
>
> **Slug:** `WHOP_LIST_PRODUCTS`
>
> List products belonging to a Whop account with cursor pagination and filters.
>
> #### Input Parameters
>
> **last** `integer`
>
> Return the last n products from the selected page.
>
> **after** `string`
>
> Return products after this cursor for forward pagination.
>
> **first** `integer`
>
> Return the first n products from the selected page.
>
> **order** `string ("created_at" | "discoverable_at")`
>
> Fields supported when ordering products.
>
> **query** `string`
>
> Text to match against product details. Omit it to browse by recency; it cannot be combined with order.
>
> **before** `string`
>
> Return products before this cursor for backward pagination.
>
> **labels** `array`
>
> Only return products carrying all of these case-insensitive labels.
>
> **direction** `string ("asc" | "desc")`
>
> Sort directions supported by Whop.
>
> **account\_id** `string` *required*
>
> The unique identifier of the account whose products to list.
>
> **plan\_types** `array`
>
> Only return products with a buyable variant of these billing models.
>
> **visibilities** `array`
>
> Only return products matching one of these visibility states.
>
> **created\_after** `string`
>
> Only return products created after this ISO 8601 timestamp.
>
> **price\_maximum** `number`
>
> Maximum displayed price of the advertised buyable variant.
>
> **price\_minimum** `number`
>
> Minimum displayed price of the advertised buyable variant.
>
> **created\_before** `string`
>
> Only return products created before this ISO 8601 timestamp.
>
> **access\_pass\_types** `array`
>
> Only return products matching one of these access pass types.
>
> **marketplace\_category\_route** `string`
>
> Only return marketplace products in this category route.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Refunds
>
> **Slug:** `WHOP_LIST_REFUNDS`
>
> List readable refunds, optionally filtered by one payment, account, or user.
>
> #### Input Parameters
>
> **last** `integer`
>
> Return the last n refunds from the selected page.
>
> **after** `string`
>
> Return refunds after this cursor for forward pagination.
>
> **first** `integer`
>
> Return the first n refunds from the selected page.
>
> **order** `string ("created_at")`
>
> Fields by which Whop can order refunds.
>
> **before** `string`
>
> Return refunds before this cursor for backward pagination.
>
> **user\_id** `string`
>
> Only return refunds to this buyer.
>
> **direction** `string ("asc" | "desc")`
>
> Sort directions supported by Whop.
>
> **account\_id** `string`
>
> Only return refunds issued by this account.
>
> **payment\_id** `string`
>
> Only return refunds for this payment.
>
> **created\_after** `string`
>
> Only return refunds created after this ISO 8601 timestamp.
>
> **created\_before** `string`
>
> Only return refunds created before this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve App
>
> **Slug:** `WHOP_RETRIEVE_APP`
>
> Tool to retrieve the details of an existing app. Use when you need to get information about a specific Whop app by its ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the app to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Authorized User
>
> **Slug:** `WHOP_RETRIEVE_AUTHORIZED_USER`
>
> Tool to retrieve the details of an existing authorized user. Use when you need to get information about a specific authorized user by their ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the authorized user to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Company
>
> **Slug:** `WHOP_RETRIEVE_COMPANY`
>
> Retrieve details of an existing company, including settings, verification status, owner information, and social links.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Company ID (e.g., 'biz\_mq2nWbR4AjIBlZ') or use 'me' to retrieve the authenticated company's details
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve company token transaction
>
> **Slug:** `WHOP_RETRIEVE_COMPANY_TOKEN_TRANSACTION`
>
> Tool to retrieve the details of an existing company token transaction. Use when you need to view information about a specific token transaction including amount, type, and associated user/member/company details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the token transaction to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Experience
>
> **Slug:** `WHOP_RETRIEVE_EXPERIENCE`
>
> Retrieve one Whop experience by its unique identifier.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the experience to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve File
>
> **Slug:** `WHOP_RETRIEVE_FILE`
>
> Tool to retrieve the details of an existing file from Whop. Use when you need to get information about a specific file by its ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the file
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Member
>
> **Slug:** `WHOP_RETRIEVE_MEMBER`
>
> Retrieve a member by ID, including their status, access level, total spending, and associated user information.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the member to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Membership
>
> **Slug:** `WHOP_RETRIEVE_MEMBERSHIP`
>
> Retrieve one Whop membership by membership ID or license key.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The membership identifier or license key to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Plan
>
> **Slug:** `WHOP_RETRIEVE_PLAN`
>
> Tool to retrieve information about an existing plan. A plan defines pricing and billing terms for a product.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the plan to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Promo Code
>
> **Slug:** `WHOP_RETRIEVE_PROMO_CODE`
>
> Tool to retrieve the details of an existing promo code by its unique identifier. Use when you need to fetch information about a specific promo code's discount settings, usage limits, and restrictions.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the promo code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve User
>
> **Slug:** `WHOP_RETRIEVE_USER`
>
> Tool to retrieve the details of an existing user from Whop. Use when you need to get information about a specific user by their ID or username.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier or username of the user
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Marketplace Products
>
> **Slug:** `WHOP_SEARCH_MARKETPLACE_PRODUCTS`
>
> Search and browse products in Whop's public marketplace.
>
> #### Input Parameters
>
> **last** `integer`
>
> Return the last n marketplace products from the selected page.
>
> **after** `string`
>
> Return marketplace products after this cursor.
>
> **first** `integer`
>
> Return the first n marketplace products from the selected page.
>
> **order** `string ("created_at" | "discoverable_at")`
>
> Fields supported when ordering products.
>
> **query** `string`
>
> Text to match against product and account details. Omit it to browse by recency; it cannot be combined with order.
>
> **before** `string`
>
> Return marketplace products before this cursor.
>
> **labels** `array`
>
> Only return products carrying all of these case-insensitive labels.
>
> **direction** `string ("asc" | "desc")`
>
> Sort directions supported by Whop.
>
> **plan\_types** `array`
>
> Only return products with a buyable variant of these billing models.
>
> **created\_after** `string`
>
> Only return products created after this ISO 8601 timestamp.
>
> **price\_maximum** `number`
>
> Maximum displayed price of the advertised buyable variant.
>
> **price\_minimum** `number`
>
> Minimum displayed price of the advertised buyable variant.
>
> **created\_before** `string`
>
> Only return products created before this ISO 8601 timestamp.
>
> **access\_pass\_types** `array`
>
> Only return products matching one of these access pass types.
>
> **marketplace\_category\_route** `string`
>
> Only return products assigned to this marketplace category route.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Experience
>
> **Slug:** `WHOP_UPDATE_EXPERIENCE`
>
> Update an experience's access, display settings, section, or position.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the experience to update.
>
> **name** `string`
>
> The display name of the experience, up to 255 characters.
>
> **order** `string`
>
> The position of the experience within its section for display ordering.
>
> **logo\_id** `string`
>
> The file identifier for the logo displayed alongside the experience name. Set null to remove the custom logo.
>
> **is\_public** `boolean`
>
> Whether the experience is publicly accessible without a membership.
>
> **section\_id** `string`
>
> The unique identifier of the section to move the experience into.
>
> **access\_level** `string ("public" | "private")`
>
> The experience access level: public or private.
>
> **notifications\_enabled** `boolean`
>
> Whether Whop app notifications are enabled for this experience. Webhooks still fire when disabled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Plan
>
> **Slug:** `WHOP_UPDATE_PLAN`
>
> Tool to update a plan's pricing, billing interval, visibility, stock, and other settings. Use when you need to modify an existing plan's configuration such as changing prices, adjusting billing periods, updating visibility status, or managing stock levels.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the plan to update (e.g., plan\_NNOponSLMOBYl)
>
> **stock** `integer`
>
> The maximum number of units available for purchase (null for unlimited)
>
> **title** `string`
>
> The display name of the plan shown to customers on the product page
>
> **currency** `string ("usd" | "eur" | "gbp" | "jpy" | "aud" | "cad" | "sgd")`
>
> Supported currencies.
>
> **visibility** `string ("visible" | "hidden" | "archived" | "quick_link")`
>
> Plan visibility options.
>
> **description** `string`
>
> A text description of the plan displayed to customers on the product page
>
> **custom\_fields** `array`
>
> An array of custom field definitions to collect additional information from customers at checkout
>
> **initial\_price** `number`
>
> The amount charged on the first purchase, in the plan's currency (e.g., 1999 for \$19.99)
>
> **renewal\_price** `number`
>
> The amount charged each billing period for recurring plans, in the plan's currency
>
> **billing\_period** `integer`
>
> The number of days between recurring charges (e.g., 30 for monthly, 365 for yearly)
>
> **internal\_notes** `string`
>
> Private notes visible only to the business owner, not shown to customers
>
> **expiration\_days** `integer`
>
> The number of days until the membership expires and access is revoked (null for no expiration)
>
> **unlimited\_stock** `boolean`
>
> When true, the stock field is ignored and the plan has unlimited availability
>
> **override\_tax\_type** `string ("inclusive" | "exclusive" | "unspecified")`
>
> Tax calculation type.
>
> **trial\_period\_days** `integer`
>
> The number of free trial days before the first charge on a recurring plan
>
> **offer\_cancel\_discount** `boolean`
>
> Whether to offer a retention discount when a customer attempts to cancel their subscription
>
> **payment\_method\_configuration** `object`
>
> Payment method configuration for the plan.
>
> **strike\_through\_initial\_price** `number`
>
> Comparison price with strikethrough for the initial charge, used to show discounts
>
> **strike\_through\_renewal\_price** `number`
>
> Comparison price with strikethrough for the renewal charge, used to show discounts
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Product
>
> **Slug:** `WHOP_UPDATE_PRODUCT`
>
> Update current presentation and catalog settings on a Whop product.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the product to update.
>
> **title** `string`
>
> The product display name. Maximum 80 characters.
>
> **labels** `array`
>
> Collection labels that replace the existing labels. Send an empty list to clear them.
>
> **headline** `string`
>
> Short product-page marketing headline. Maximum 80 characters.
>
> **metadata** `object`
>
> Custom key-value pairs stored on the product.
>
> **visibility** `string`
>
> The product visibility value accepted by the current Whop API.
>
> **description** `string`
>
> Product-page description. Maximum 1,500 characters.
>
> **banner\_image** `object`
>
> An existing attachment or completed direct upload.
>
> **gallery\_images** `array`
>
> Ordered gallery images or videos. Replaces the gallery; an empty list clears it, while null leaves it unchanged.
>
> **product\_tax\_code\_id** `string`
>
> The unique identifier of the product tax classification code.
>
> **send\_welcome\_message** `boolean`
>
> Whether to send a support-chat welcome message when a user joins.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
