Whop
whopMaking everyone an internet entrepreneur. Explore a playground for digital products, memberships & communities.
Acciones disponibles (19)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create Access TokenWHOP_CREATE_ACCESS_TOKENAcciónTool to create a short-lived access token for authenticating API requests. Use when you need to generate temporary credentials for Whop's web and mobile embedded components.
WHOP_CREATE_ACCESS_TOKENAcciónTool to create a short-lived access token for authenticating API requests. Use when you need to generate temporary credentials for Whop's web and mobile embedded components.
Parámetros de entrada
user_idstringUser identifier. Required when using API key authentication. Cannot be used together with company_id.
company_idstringBusiness identifier. Required when using API key authentication. Cannot be used together with user_id.
expires_atstringToken expiration timestamp in ISO 8601 format (defaults to 1 hour, max 3 hours from now).
scoped_actionsstring[]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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create fileWHOP_CREATE_FILEAcciónTool 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.
WHOP_CREATE_FILEAcciónTool 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.
Parámetros de entrada
filenamestringObligatorioThe name of the file including its extension (e.g., 'photo.png' or 'document.pdf').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Promo CodeWHOP_DELETE_PROMO_CODEAcciónTool 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'.
WHOP_DELETE_PROMO_CODEAcciónTool 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'.
Parámetros de entrada
idstringObligatorioThe unique identifier of the promo code to archive. Format: promo_xxxxxxxxxxxx
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List AppsWHOP_LIST_APPSAcciónTool 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.
WHOP_LIST_APPSAcciónTool 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.
Parámetros de entrada
lastintegerReturns the last n elements from the list
afterstringReturns the elements in the list that come after the specified cursor
firstintegerReturns the first n elements from the list
orderstringenumField to sort apps by.
discoverable_atcreated_attotal_installs_last_30_daystotal_installs_last_7_daystime_spenttime_spent_last_24_hoursdaily_active_usersai_prompt_counttotal_ai_cost_usdtotal_ai_tokenslast_ai_prompt_atai_average_ratingquerystringA search string to filter apps by name
beforestringReturns the elements in the list that come before the specified cursor
app_typestringenumAudience type for apps.
b2b_appb2c_appcompany_appcomponentdirectionstringenumSort direction for results.
ascdescview_typestringenumView types supported by apps.
hubdiscoverdashdashboardanalyticscompany_idstringFilter apps to only those created by this company (format: biz_*)
verified_apps_onlybooleanWhether to only return apps that have been verified by Whop
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Authorized UsersWHOP_LIST_AUTHORIZED_USERSAcciónTool 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.
WHOP_LIST_AUTHORIZED_USERSAcciónTool 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.
Parámetros de entrada
lastintegerReturns the last n elements from the list. Cannot be used with 'first'
rolestringenumEnum for authorized user roles within a company.
owneradminsales_managermoderatorapp_managersupportmanagerafterstringReturns the elements in the list that come after the specified cursor. Used for forward pagination
firstintegerReturns the first n elements from the list. Cannot be used with 'last'
beforestringReturns the elements in the list that come before the specified cursor. Used for backward pagination
user_idstringFilter results to a specific user to check if they are an authorized team member
company_idstringThe unique identifier of the company to filter authorized users by (e.g., biz_xxxxxxxxxxxxxx)
created_afterstringOnly return authorized users created after this timestamp (ISO 8601 date-time format)
created_beforestringOnly return authorized users created before this timestamp (ISO 8601 date-time format)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List MembersWHOP_LIST_MEMBERSAcciónTool 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.
WHOP_LIST_MEMBERSAcciónTool 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.
Parámetros de entrada
lastintegerReturns the last n elements from the list
afterstringReturns the elements in the list that come after the specified cursor
firstintegerReturns the first n elements from the list
orderstringenumSort order field values.
idusd_total_spentcreated_atjoined_atmost_recent_actionquerystringSearch members by name, username, or email
beforestringReturns the elements in the list that come before the specified cursor
plan_idsstring[]Filter by specific plan identifiers
statusesstring[]Filter by member status: drafted, joined, or left
user_idsstring[]Filter by specific user identifiers
directionstringenumSort direction values.
ascdesccompany_idstringCompany identifier to list members for. If omitted, defaults to the company associated with the API key.
product_idsstring[]Filter by specific product identifiers
access_levelstringenumAccess level a user or company has to a product or company.
no_accessadmincustomercreated_afterstringFilter members created after this timestamp (ISO 8601 date-time)
created_beforestringFilter members created before this timestamp (ISO 8601 date-time)
promo_code_idsstring[]Filter by promo codes used
most_recent_actionsstring[]Filter by recent activity types
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List membershipsWHOP_LIST_MEMBERSHIPSAcciónTool 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.
WHOP_LIST_MEMBERSHIPSAcciónTool 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.
Parámetros de entrada
lastintegerReturns the last n elements from the list. Use for backward pagination.
afterstringPagination cursor that returns elements in the list after the specified cursor. Use this to fetch the next page of results.
firstintegerReturns the first n elements from the list. Use for forward pagination.
orderstringenumOrder by field enum.
idcreated_atstatuscanceled_atdate_joinedtotal_spendbeforestringPagination cursor that returns elements in the list before the specified cursor. Use this to fetch the previous page of results.
plan_idsstring[]Filter to only include memberships belonging to these plan identifiers. Pass multiple plan IDs to filter by multiple plans.
statusesstring[]Filter memberships by their current status. Can include multiple statuses to match any of them.
user_idsstring[]Filter to only include memberships belonging to these user identifiers. Pass multiple user IDs to filter by multiple users.
directionstringenumSort direction enum.
ascdesccompany_idstringThe unique identifier of the company to list memberships for. Required when using an API key authentication.
product_idsstring[]Filter to only include memberships belonging to these product identifiers. Pass multiple product IDs to filter by multiple products.
created_afterstringdate-timeOnly return memberships created after this timestamp. Use ISO 8601 format.
cancel_optionsstring[]Filter to only include memberships matching these cancellation reasons. Only applicable to canceled memberships.
created_beforestringdate-timeOnly return memberships created before this timestamp. Use ISO 8601 format.
promo_code_idsstring[]Filter to only include memberships that used these promo code identifiers during checkout.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Payment MethodsWHOP_LIST_PAYMENT_METHODSAcciónTool 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.
WHOP_LIST_PAYMENT_METHODSAcciónTool 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.
Parámetros de entrada
lastintegerReturns the last n elements from the list. Cannot be used with 'first' parameter.
afterstringCursor for paginating forward through results. Use the end_cursor from the previous response.
firstintegerReturns the first n elements from the list. Cannot be used with 'last' parameter.
beforestringCursor for paginating backward through results. Use the start_cursor from the previous response.
directionstringenumSort direction for pagination.
ascdescmember_idstringThe unique identifier of the member. Either member_id or company_id must be provided.
company_idstringThe unique identifier of the company. Either member_id or company_id must be provided.
created_afterstringFilter to payment methods created after this ISO 8601 timestamp.
created_beforestringFilter to payment methods created before this ISO 8601 timestamp.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PaymentsWHOP_LIST_PAYMENTSAcciónTool 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.
WHOP_LIST_PAYMENTSAcciónTool 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.
Parámetros de entrada
lastintegerReturns the last n elements from the list
afterstringReturns the elements in the list that come after the specified cursor
firstintegerReturns the first n elements from the list
orderstringenumSort order field values.
final_amountcreated_atpaid_atbeforestringReturns the elements in the list that come before the specified cursor
plan_idsstring[]Filter by specific plan identifiers
statusesstring[]Filter by payment status
directionstringenumSort direction values.
ascdesccompany_idstringThe unique identifier of the company to list payments for. If omitted, defaults to the company associated with the API key.
currenciesstring[]Filter by currency code (usd, eur, gbp, etc.)
product_idsstring[]Filter by specific product identifiers
substatusesstring[]Filter by friendly status for granular filtering
include_freebooleanWhether to include payments with a zero amount
created_afterstringOnly return payments created after this timestamp (ISO 8601 date-time)
created_beforestringOnly return payments created before this timestamp (ISO 8601 date-time)
billing_reasonsstring[]Filter by billing reason
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve AppWHOP_RETRIEVE_APPAcciónTool to retrieve the details of an existing app. Use when you need to get information about a specific Whop app by its ID.
WHOP_RETRIEVE_APPAcciónTool to retrieve the details of an existing app. Use when you need to get information about a specific Whop app by its ID.
Parámetros de entrada
idstringObligatorioThe unique identifier of the app to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Authorized UserWHOP_RETRIEVE_AUTHORIZED_USERAcciónTool to retrieve the details of an existing authorized user. Use when you need to get information about a specific authorized user by their ID.
WHOP_RETRIEVE_AUTHORIZED_USERAcciónTool to retrieve the details of an existing authorized user. Use when you need to get information about a specific authorized user by their ID.
Parámetros de entrada
idstringObligatorioThe unique identifier of the authorized user to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve CompanyWHOP_RETRIEVE_COMPANYAcciónTool to retrieve the details of an existing company. Use when you need to fetch company information including settings, team details, verification status, and social links.
WHOP_RETRIEVE_COMPANYAcciónTool to retrieve the details of an existing company. Use when you need to fetch company information including settings, team details, verification status, and social links.
Parámetros de entrada
idstringObligatorioCompany ID (e.g., 'biz_mq2nWbR4AjIBlZ') or use 'me' to retrieve the authenticated company's details
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve company token transactionWHOP_RETRIEVE_COMPANY_TOKEN_TRANSACTIONAcciónTool 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.
WHOP_RETRIEVE_COMPANY_TOKEN_TRANSACTIONAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe unique identifier of the token transaction to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve FileWHOP_RETRIEVE_FILEAcciónTool to retrieve the details of an existing file from Whop. Use when you need to get information about a specific file by its ID.
WHOP_RETRIEVE_FILEAcciónTool to retrieve the details of an existing file from Whop. Use when you need to get information about a specific file by its ID.
Parámetros de entrada
idstringObligatorioThe unique identifier of the file
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve MemberWHOP_RETRIEVE_MEMBERAcciónTool to retrieve detailed information about an existing member by ID. Use when you need to get a specific member's details including their status, access level, spending history, and associated user information.
WHOP_RETRIEVE_MEMBERAcciónTool to retrieve detailed information about an existing member by ID. Use when you need to get a specific member's details including their status, access level, spending history, and associated user information.
Parámetros de entrada
idstringObligatorioThe unique identifier of the member to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve PlanWHOP_RETRIEVE_PLANAcciónTool to retrieve information about an existing plan. A plan defines pricing and billing terms for a product.
WHOP_RETRIEVE_PLANAcciónTool to retrieve information about an existing plan. A plan defines pricing and billing terms for a product.
Parámetros de entrada
idstringObligatorioThe unique identifier of the plan to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Promo CodeWHOP_RETRIEVE_PROMO_CODEAcciónTool 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.
WHOP_RETRIEVE_PROMO_CODEAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe unique identifier of the promo code.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve UserWHOP_RETRIEVE_USERAcciónTool 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.
WHOP_RETRIEVE_USERAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe unique identifier or username of the user
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update PlanWHOP_UPDATE_PLANAcciónTool 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.
WHOP_UPDATE_PLANAcciónTool 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.
Parámetros de entrada
idstringObligatorioThe unique identifier of the plan to update (e.g., plan_NNOponSLMOBYl)
stockintegerThe maximum number of units available for purchase (null for unlimited)
titlestringThe display name of the plan shown to customers on the product page
currencystringenumSupported currencies.
usdeurgbpjpyaudcadsgdvisibilitystringenumPlan visibility options.
visiblehiddenarchivedquick_linkdescriptionstringA text description of the plan displayed to customers on the product page
custom_fieldsobject[]An array of custom field definitions to collect additional information from customers at checkout
initial_pricenumberThe amount charged on the first purchase, in the plan's currency (e.g., 1999 for $19.99)
renewal_pricenumberThe amount charged each billing period for recurring plans, in the plan's currency
billing_periodintegerThe number of days between recurring charges (e.g., 30 for monthly, 365 for yearly)
internal_notesstringPrivate notes visible only to the business owner, not shown to customers
expiration_daysintegerThe number of days until the membership expires and access is revoked (null for no expiration)
unlimited_stockbooleanWhen true, the stock field is ignored and the plan has unlimited availability
override_tax_typestringenumTax calculation type.
inclusiveexclusiveunspecifiedtrial_period_daysintegerThe number of free trial days before the first charge on a recurring plan
offer_cancel_discountbooleanWhether to offer a retention discount when a customer attempts to cancel their subscription
payment_method_configurationobjectPayment method configuration for the plan.
strike_through_initial_pricenumberComparison price with strikethrough for the initial charge, used to show discounts
strike_through_renewal_pricenumberComparison price with strikethrough for the renewal charge, used to show discounts
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not