NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Whop

whop

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

EcommerceWeb del proveedor
Acciones
19
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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_idstring

    User identifier. Required when using API key authentication. Cannot be used together with company_id.

  • company_idstring

    Business identifier. Required when using API key authentication. Cannot be used together with user_id.

  • expires_atstring

    Token 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create fileWHOP_CREATE_FILEAcción

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.

Parámetros de entrada

  • filenamestringObligatorio

    The name of the file including its extension (e.g., 'photo.png' or 'document.pdf').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Promo CodeWHOP_DELETE_PROMO_CODEAcción

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

Parámetros de entrada

  • idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List AppsWHOP_LIST_APPSAcción

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.

Parámetros de entrada

  • lastinteger

    Returns the last n elements from the list

  • afterstring

    Returns the elements in the list that come after the specified cursor

  • firstinteger

    Returns the first n elements from the list

  • orderstringenum

    Field 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_rating
  • querystring

    A search string to filter apps by name

  • beforestring

    Returns the elements in the list that come before the specified cursor

  • app_typestringenum

    Audience type for apps.

    b2b_appb2c_appcompany_appcomponent
  • directionstringenum

    Sort direction for results.

    ascdesc
  • view_typestringenum

    View types supported by apps.

    hubdiscoverdashdashboardanalytics
  • company_idstring

    Filter apps to only those created by this company (format: biz_*)

  • verified_apps_onlyboolean

    Whether to only return apps that have been verified by Whop

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Authorized UsersWHOP_LIST_AUTHORIZED_USERSAcción

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.

Parámetros de entrada

  • lastinteger

    Returns the last n elements from the list. Cannot be used with 'first'

  • rolestringenum

    Enum for authorized user roles within a company.

    owneradminsales_managermoderatorapp_managersupportmanager
  • afterstring

    Returns the elements in the list that come after the specified cursor. Used for forward pagination

  • firstinteger

    Returns the first n elements from the list. Cannot be used with 'last'

  • beforestring

    Returns the elements in the list that come before the specified cursor. Used for backward pagination

  • user_idstring

    Filter results to a specific user to check if they are an authorized team member

  • company_idstring

    The unique identifier of the company to filter authorized users by (e.g., biz_xxxxxxxxxxxxxx)

  • created_afterstring

    Only return authorized users created after this timestamp (ISO 8601 date-time format)

  • created_beforestring

    Only return authorized users created before this timestamp (ISO 8601 date-time format)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List MembersWHOP_LIST_MEMBERSAcción

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.

Parámetros de entrada

  • lastinteger

    Returns the last n elements from the list

  • afterstring

    Returns the elements in the list that come after the specified cursor

  • firstinteger

    Returns the first n elements from the list

  • orderstringenum

    Sort order field values.

    idusd_total_spentcreated_atjoined_atmost_recent_action
  • querystring

    Search members by name, username, or email

  • beforestring

    Returns 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

  • directionstringenum

    Sort direction values.

    ascdesc
  • company_idstring

    Company identifier to list members for. If omitted, defaults to the company associated with the API key.

  • product_idsstring[]

    Filter by specific product identifiers

  • access_levelstringenum

    Access level a user or company has to a product or company.

    no_accessadmincustomer
  • created_afterstring

    Filter members created after this timestamp (ISO 8601 date-time)

  • created_beforestring

    Filter 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List membershipsWHOP_LIST_MEMBERSHIPSAcción

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.

Parámetros de entrada

  • lastinteger

    Returns the last n elements from the list. Use for backward pagination.

  • afterstring

    Pagination cursor that returns elements in the list after the specified cursor. Use this to fetch the next page of results.

  • firstinteger

    Returns the first n elements from the list. Use for forward pagination.

  • orderstringenum

    Order by field enum.

    idcreated_atstatuscanceled_atdate_joinedtotal_spend
  • beforestring

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

  • directionstringenum

    Sort direction enum.

    ascdesc
  • company_idstring

    The 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-time

    Only 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-time

    Only 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Payment MethodsWHOP_LIST_PAYMENT_METHODSAcción

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.

Parámetros de entrada

  • lastinteger

    Returns the last n elements from the list. Cannot be used with 'first' parameter.

  • afterstring

    Cursor for paginating forward through results. Use the end_cursor from the previous response.

  • firstinteger

    Returns the first n elements from the list. Cannot be used with 'last' parameter.

  • beforestring

    Cursor for paginating backward through results. Use the start_cursor from the previous response.

  • directionstringenum

    Sort direction for pagination.

    ascdesc
  • member_idstring

    The unique identifier of the member. Either member_id or company_id must be provided.

  • company_idstring

    The unique identifier of the company. Either member_id or company_id must be provided.

  • created_afterstring

    Filter to payment methods created after this ISO 8601 timestamp.

  • created_beforestring

    Filter to payment methods created before this ISO 8601 timestamp.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List PaymentsWHOP_LIST_PAYMENTSAcción

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.

Parámetros de entrada

  • lastinteger

    Returns the last n elements from the list

  • afterstring

    Returns the elements in the list that come after the specified cursor

  • firstinteger

    Returns the first n elements from the list

  • orderstringenum

    Sort order field values.

    final_amountcreated_atpaid_at
  • beforestring

    Returns the elements in the list that come before the specified cursor

  • plan_idsstring[]

    Filter by specific plan identifiers

  • statusesstring[]

    Filter by payment status

  • directionstringenum

    Sort direction values.

    ascdesc
  • company_idstring

    The 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_freeboolean

    Whether to include payments with a zero amount

  • created_afterstring

    Only return payments created after this timestamp (ISO 8601 date-time)

  • created_beforestring

    Only return payments created before this timestamp (ISO 8601 date-time)

  • billing_reasonsstring[]

    Filter by billing reason

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve AppWHOP_RETRIEVE_APPAcción

Tool 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

  • idstringObligatorio

    The unique identifier of the app to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Authorized UserWHOP_RETRIEVE_AUTHORIZED_USERAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the authorized user to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve CompanyWHOP_RETRIEVE_COMPANYAcción

Tool 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

  • idstringObligatorio

    Company ID (e.g., 'biz_mq2nWbR4AjIBlZ') or use 'me' to retrieve the authenticated company's details

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve company token transactionWHOP_RETRIEVE_COMPANY_TOKEN_TRANSACTIONAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the token transaction to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve FileWHOP_RETRIEVE_FILEAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the file

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve MemberWHOP_RETRIEVE_MEMBERAcción

Tool 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

  • idstringObligatorio

    The unique identifier of the member to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve PlanWHOP_RETRIEVE_PLANAcción

Tool to retrieve information about an existing plan. A plan defines pricing and billing terms for a product.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the plan to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Promo CodeWHOP_RETRIEVE_PROMO_CODEAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the promo code.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve UserWHOP_RETRIEVE_USERAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier or username of the user

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update PlanWHOP_UPDATE_PLANAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the plan to update (e.g., plan_NNOponSLMOBYl)

  • stockinteger

    The maximum number of units available for purchase (null for unlimited)

  • titlestring

    The display name of the plan shown to customers on the product page

  • currencystringenum

    Supported currencies.

    usdeurgbpjpyaudcadsgd
  • visibilitystringenum

    Plan visibility options.

    visiblehiddenarchivedquick_link
  • descriptionstring

    A 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_pricenumber

    The amount charged on the first purchase, in the plan's currency (e.g., 1999 for $19.99)

  • renewal_pricenumber

    The amount charged each billing period for recurring plans, in the plan's currency

  • billing_periodinteger

    The number of days between recurring charges (e.g., 30 for monthly, 365 for yearly)

  • internal_notesstring

    Private notes visible only to the business owner, not shown to customers

  • expiration_daysinteger

    The number of days until the membership expires and access is revoked (null for no expiration)

  • unlimited_stockboolean

    When true, the stock field is ignored and the plan has unlimited availability

  • override_tax_typestringenum

    Tax calculation type.

    inclusiveexclusiveunspecified
  • trial_period_daysinteger

    The number of free trial days before the first charge on a recurring plan

  • offer_cancel_discountboolean

    Whether to offer a retention discount when a customer attempts to cancel their subscription

  • payment_method_configurationobject

    Payment method configuration for the plan.

  • strike_through_initial_pricenumber

    Comparison price with strikethrough for the initial charge, used to show discounts

  • strike_through_renewal_pricenumber

    Comparison price with strikethrough for the renewal charge, used to show discounts

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not