Skip to main content
Whop logo
  • Category: ecommerce
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 35
  • Triggers: 0
  • Slug: WHOP
  • Version: 20261101_00

Tools

Slug: WHOP_ATTACH_EXPERIENCEAttach an experience to a product so its customers gain access.

Input Parameters

string
required
The unique identifier of the experience to attach.
string
required
The unique identifier of the product that should grant access to the experience.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_CHECK_PERMISSIONSCheck which permission actions the caller has on a Whop resource.

Input Parameters

array
Permission actions to check. Omit to return every permission action.
string
required
The account, product, experience, or app resource identifier to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_CREATE_ACCESS_TOKENCreate 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

string
User identifier. Required when using API key authentication. Cannot be used together with company_id.
string
Business identifier. Required when using API key authentication. Cannot be used together with user_id.
string
Token expiration timestamp in ISO 8601 format (defaults to 1 hour, max 3 hours from now).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_CREATE_EXPERIENCECreate an app-powered experience for a Whop account.

Input Parameters

string
The display name of the experience. Defaults to the app name when omitted.
string
required
The unique identifier of the app that powers the experience.
string
The unique identifier of the file to use as the experience logo.
boolean
Whether the experience is publicly accessible without a membership.
string
required
The unique identifier of the Whop account that will own the experience.
string
The unique identifier of the section in which to place the experience.
boolean
Whether Whop app notifications are enabled for the experience. Webhooks still fire when disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_CREATE_FILETool 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

string
required
The name of the file including its extension (e.g., ‘photo.png’ or ‘document.pdf’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_CREATE_PRODUCTCreate a Whop digital product for an account.

Input Parameters

string
The URL slug used in the product’s public link.
string
required
The display name of the product.
array
Labels used to group products into collections. Whop stores them lowercased and de-duplicated.
string
A short marketing headline displayed prominently on the product page.
object
Custom key-value metadata included in payment and membership webhooks.
string
The account that will own the product. Omit it when the credential supplies the account.
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.
string
Whether and how the product is visible to customers.
string
A written description displayed on the product page.
string
A URL opened by the call-to-action instead of the default checkout flow.
Images or videos displayed in the product gallery, in display order. Send an empty array to clear it.
string
A unique key sent as Idempotency-Key to make retries safe.
string
The unique identifier of the tax classification code for the product.
boolean
Whether to send an automated support-chat welcome message when a user joins.
string
The URL to redirect a customer to after a completed purchase.
string ("enabled" | "disabled")
Product affiliate program enrollment states.
string ("enabled" | "disabled")
Product affiliate program enrollment states.
boolean
Whether checkout collects the customer’s shipping address.
string
Custom bank statement descriptor. Must start with WHOP*.
number
Commission percentage earned through the global affiliate program.
number
Commission percentage earned by members through referrals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_CREATE_VARIANTCreate a product-backed or standalone purchasable Whop pricing variant.

Input Parameters

string
A seller-defined stock keeping unit; it need not be unique.
object
Image reference accepted when creating a variant.
integer
The maximum units available for purchase when stock is limited.
string
The customer-facing display name of the variant.
string
The three-letter ISO currency code for pricing. Whop defaults to usd.
object
Custom key-value pairs stored on the variant.
string
The variant billing type.
string
The account that will own the variant. Required when authenticating as a user; an account API key supplies its own account.
object
Attribute names and values that distinguish this variant.
string
The product to attach this variant to. Omit it for a standalone variant.
string ("visible" | "hidden" | "archived" | "quick_link")
Visibility options for a Whop variant.
string
A customer-facing description of the variant.
array
Custom fields to collect from customers at checkout.
number
The initial amount charged in the variant’s currency. Use 0 for a free variant.
number
The amount charged each billing period for a recurring variant.
integer
The recurring billing interval in days, such as 30 for monthly billing.
string
Private notes visible only to the account owner.
string
The sales method for this variant.
string ("mandate_challenge" | "mandate_if_required" | "frictionless_if_required")
3D Secure preferences accepted for a variant.
integer
The number of days before access through this variant expires.
string
A unique key sent as Idempotency-Key to make retries safe.
boolean
Whether the variant has unlimited stock. When true, stock is ignored.
object
Checkout styling overrides for this variant.
string
A tax classification override for this variant.
integer
The number of free trial days before the first recurring charge.
boolean
Whether this variant accepts adaptive local-currency pricing.
integer
Installments required before a split-pay subscription pauses.
object
Payment overrides requiring at least one of enabled or disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_DELETE_EXPERIENCEPermanently delete an experience and detach it from every product.

Input Parameters

string
required
The unique identifier of the experience to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_DELETE_PROMO_CODETool 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

string
required
The unique identifier of the promo code to archive. Format: promo_xxxxxxxxxxxx

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_DETACH_EXPERIENCEDetach an experience from a product, removing access through that product.

Input Parameters

string
required
The unique identifier of the experience to detach.
string
required
The unique identifier of the product that should no longer grant access to the experience.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_APPSTool 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

integer
Returns the last n elements from the list
string
Returns the elements in the list that come after the specified cursor
integer
Returns the first n elements from the list
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.
string
A search string to filter apps by name
string
Returns the elements in the list that come before the specified cursor
string ("b2b_app" | "b2c_app" | "company_app" | "component")
Audience type for apps.
string ("asc" | "desc")
Sort direction for results.
string ("hub" | "discover" | "dash" | "dashboard" | "analytics")
View types supported by apps.
string
Filter apps to only those created by this company (format: biz_*)
boolean
Whether to only return apps that have been verified by Whop

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_AUTHORIZED_USERSTool 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

integer
Returns the last n elements from the list. Cannot be used with ‘first’
string ("owner" | "admin" | "sales_manager" | "moderator" | "app_manager" | "support" | "manager")
Enum for authorized user roles within a company.
string
Returns the elements in the list that come after the specified cursor. Used for forward pagination
integer
Returns the first n elements from the list. Cannot be used with ‘last’
string
Returns the elements in the list that come before the specified cursor. Used for backward pagination
string
Filter results to a specific user to check if they are an authorized team member
string
The unique identifier of the company to filter authorized users by (e.g., biz_xxxxxxxxxxxxxx)
string
Only return authorized users created after this timestamp (ISO 8601 date-time format)
string
Only return authorized users created before this timestamp (ISO 8601 date-time format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_MEMBERSTool 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

integer
Returns the last n elements from the list
string
Returns the elements in the list that come after the specified cursor
integer
Returns the first n elements from the list
string ("id" | "usd_total_spent" | "created_at" | "joined_at" | "most_recent_action")
Sort order field values.
string
Search members by name, username, or email
string
Returns the elements in the list that come before the specified cursor
array
Filter by specific plan identifiers
array
Filter by member status: drafted, joined, or left
array
Filter by specific user identifiers
string ("asc" | "desc")
Sort direction values.
string
Company identifier to list members for. If omitted, defaults to the company associated with the API key.
array
Filter by specific product identifiers
string ("no_access" | "admin" | "customer")
Access level a user or company has to a product or company.
string
Filter members created after this timestamp (ISO 8601 date-time)
string
Filter members created before this timestamp (ISO 8601 date-time)
array
Filter by promo codes used
array
Filter by recent activity types

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_MEMBERSHIPSTool 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

integer
Returns the last n elements from the list. Use for backward pagination.
string
Pagination cursor that returns elements in the list after the specified cursor. Use this to fetch the next page of results.
integer
Returns the first n elements from the list. Use for forward pagination.
string ("id" | "created_at" | "status" | "canceled_at" | "date_joined" | "total_spend")
Order by field enum.
string
Pagination cursor that returns elements in the list before the specified cursor. Use this to fetch the previous page of results.
array
Filter to only include memberships belonging to these plan identifiers. Pass multiple plan IDs to filter by multiple plans.
array
Filter memberships by their current status. Can include multiple statuses to match any of them.
array
Filter to only include memberships belonging to these user identifiers. Pass multiple user IDs to filter by multiple users.
string ("asc" | "desc")
Sort direction enum.
string
The unique identifier of the company to list memberships for. Required when using an API key authentication.
array
Filter to only include memberships belonging to these product identifiers. Pass multiple product IDs to filter by multiple products.
string
Only return memberships created after this timestamp. Use ISO 8601 format.
array
Filter to only include memberships matching these cancellation reasons. Only applicable to canceled memberships.
string
Only return memberships created before this timestamp. Use ISO 8601 format.
array
Filter to only include memberships that used these promo code identifiers during checkout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_MESSAGESList messages in an experience chat, DM, or group chat channel.

Input Parameters

integer
Return the last n messages from the selected page.
string
Return messages after this cursor for forward pagination.
integer
Return the first n messages from the selected page.
string
Return messages before this cursor for backward pagination.
string ("asc" | "desc")
Sort directions supported for messages.
string
required
The unique identifier of the channel or experience to list messages for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_PAYMENT_FEESReturn the complete fee breakdown for one Whop payment.

Input Parameters

string
required
The payment whose fees to list, prefixed pay_.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_PAYMENT_METHODSTool 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

integer
Returns the last n elements from the list. Cannot be used with ‘first’ parameter.
string
Cursor for paginating forward through results. Use the end_cursor from the previous response.
integer
Returns the first n elements from the list. Cannot be used with ‘last’ parameter.
string
Cursor for paginating backward through results. Use the start_cursor from the previous response.
string ("asc" | "desc")
Sort direction for pagination.
string
The unique identifier of the member. Either member_id or company_id must be provided.
string
The unique identifier of the company. Either member_id or company_id must be provided.
string
Filter to payment methods created after this ISO 8601 timestamp.
string
Filter to payment methods created before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_PAYMENTSTool 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

integer
Returns the last n elements from the list
string
Returns the elements in the list that come after the specified cursor
integer
Returns the first n elements from the list
string ("final_amount" | "created_at" | "paid_at")
Sort order field values.
string
Returns the elements in the list that come before the specified cursor
array
Filter by specific plan identifiers
array
Filter by payment status
string ("asc" | "desc")
Sort direction values.
string
The unique identifier of the company to list payments for. If omitted, defaults to the company associated with the API key.
array
Filter by currency code (usd, eur, gbp, etc.)
array
Filter by specific product identifiers
array
Filter by friendly status for granular filtering
boolean
Whether to include payments with a zero amount
string
Only return payments created after this timestamp (ISO 8601 date-time)
string
Only return payments created before this timestamp (ISO 8601 date-time)
array
Filter by billing reason

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_PRODUCTSList products belonging to a Whop account with cursor pagination and filters.

Input Parameters

integer
Return the last n products from the selected page.
string
Return products after this cursor for forward pagination.
integer
Return the first n products from the selected page.
string ("created_at" | "discoverable_at")
Fields supported when ordering products.
string
Text to match against product details. Omit it to browse by recency; it cannot be combined with order.
string
Return products before this cursor for backward pagination.
array
Only return products carrying all of these case-insensitive labels.
string ("asc" | "desc")
Sort directions supported by Whop.
string
required
The unique identifier of the account whose products to list.
array
Only return products with a buyable variant of these billing models.
array
Only return products matching one of these visibility states.
string
Only return products created after this ISO 8601 timestamp.
number
Maximum displayed price of the advertised buyable variant.
number
Minimum displayed price of the advertised buyable variant.
string
Only return products created before this ISO 8601 timestamp.
array
Only return products matching one of these access pass types.
string
Only return marketplace products in this category route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_LIST_REFUNDSList readable refunds, optionally filtered by one payment, account, or user.

Input Parameters

integer
Return the last n refunds from the selected page.
string
Return refunds after this cursor for forward pagination.
integer
Return the first n refunds from the selected page.
string ("created_at")
Fields by which Whop can order refunds.
string
Return refunds before this cursor for backward pagination.
string
Only return refunds to this buyer.
string ("asc" | "desc")
Sort directions supported by Whop.
string
Only return refunds issued by this account.
string
Only return refunds for this payment.
string
Only return refunds created after this ISO 8601 timestamp.
string
Only return refunds created before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_APPTool 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

string
required
The unique identifier of the app to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_AUTHORIZED_USERTool 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

string
required
The unique identifier of the authorized user to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_COMPANYRetrieve details of an existing company, including settings, verification status, owner information, and social links.

Input Parameters

string
required
Company ID (e.g., ‘biz_mq2nWbR4AjIBlZ’) or use ‘me’ to retrieve the authenticated company’s details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_COMPANY_TOKEN_TRANSACTIONTool 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

string
required
The unique identifier of the token transaction to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_EXPERIENCERetrieve one Whop experience by its unique identifier.

Input Parameters

string
required
The unique identifier of the experience to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_FILETool 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

string
required
The unique identifier of the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_MEMBERRetrieve a member by ID, including their status, access level, total spending, and associated user information.

Input Parameters

string
required
The unique identifier of the member to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_MEMBERSHIPRetrieve one Whop membership by membership ID or license key.

Input Parameters

string
required
The membership identifier or license key to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_PLANTool to retrieve information about an existing plan. A plan defines pricing and billing terms for a product.

Input Parameters

string
required
The unique identifier of the plan to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_PROMO_CODETool 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

string
required
The unique identifier of the promo code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_RETRIEVE_USERTool 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

string
required
The unique identifier or username of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_SEARCH_MARKETPLACE_PRODUCTSSearch and browse products in Whop’s public marketplace.

Input Parameters

integer
Return the last n marketplace products from the selected page.
string
Return marketplace products after this cursor.
integer
Return the first n marketplace products from the selected page.
string ("created_at" | "discoverable_at")
Fields supported when ordering products.
string
Text to match against product and account details. Omit it to browse by recency; it cannot be combined with order.
string
Return marketplace products before this cursor.
array
Only return products carrying all of these case-insensitive labels.
string ("asc" | "desc")
Sort directions supported by Whop.
array
Only return products with a buyable variant of these billing models.
string
Only return products created after this ISO 8601 timestamp.
number
Maximum displayed price of the advertised buyable variant.
number
Minimum displayed price of the advertised buyable variant.
string
Only return products created before this ISO 8601 timestamp.
array
Only return products matching one of these access pass types.
string
Only return products assigned to this marketplace category route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_UPDATE_EXPERIENCEUpdate an experience’s access, display settings, section, or position.

Input Parameters

string
required
The unique identifier of the experience to update.
string
The display name of the experience, up to 255 characters.
string
The position of the experience within its section for display ordering.
string
The file identifier for the logo displayed alongside the experience name. Set null to remove the custom logo.
boolean
Whether the experience is publicly accessible without a membership.
string
The unique identifier of the section to move the experience into.
string ("public" | "private")
The experience access level: public or private.
boolean
Whether Whop app notifications are enabled for this experience. Webhooks still fire when disabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_UPDATE_PLANTool 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

string
required
The unique identifier of the plan to update (e.g., plan_NNOponSLMOBYl)
integer
The maximum number of units available for purchase (null for unlimited)
string
The display name of the plan shown to customers on the product page
string ("usd" | "eur" | "gbp" | "jpy" | "aud" | "cad" | "sgd")
Supported currencies.
string ("visible" | "hidden" | "archived" | "quick_link")
Plan visibility options.
string
A text description of the plan displayed to customers on the product page
array
An array of custom field definitions to collect additional information from customers at checkout
number
The amount charged on the first purchase, in the plan’s currency (e.g., 1999 for $19.99)
number
The amount charged each billing period for recurring plans, in the plan’s currency
integer
The number of days between recurring charges (e.g., 30 for monthly, 365 for yearly)
string
Private notes visible only to the business owner, not shown to customers
integer
The number of days until the membership expires and access is revoked (null for no expiration)
boolean
When true, the stock field is ignored and the plan has unlimited availability
string ("inclusive" | "exclusive" | "unspecified")
Tax calculation type.
integer
The number of free trial days before the first charge on a recurring plan
boolean
Whether to offer a retention discount when a customer attempts to cancel their subscription
object
Payment method configuration for the plan.
number
Comparison price with strikethrough for the initial charge, used to show discounts
number
Comparison price with strikethrough for the renewal charge, used to show discounts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHOP_UPDATE_PRODUCTUpdate current presentation and catalog settings on a Whop product.

Input Parameters

string
required
The unique identifier of the product to update.
string
The product display name. Maximum 80 characters.
array
Collection labels that replace the existing labels. Send an empty list to clear them.
string
Short product-page marketing headline. Maximum 80 characters.
object
Custom key-value pairs stored on the product.
string
The product visibility value accepted by the current Whop API.
string
Product-page description. Maximum 1,500 characters.
object
An existing attachment or completed direct upload.
Ordered gallery images or videos. Replaces the gallery; an empty list clears it, while null leaves it unchanged.
string
The unique identifier of the product tax classification code.
boolean
Whether to send a support-chat welcome message when a user joins.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not