From d72f42015e97c13f5402c3454878699fdd95f7c3 Mon Sep 17 00:00:00 2001
From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com>
Date: Tue, 8 Sep 2026 20:01:13 +0000
Subject: [PATCH 1/2] [fern-generated] Update SDK
Generated by Fern
CLI Version: unknown
Generators:
- fernapi/fern-python-sdk: 5.28.0
---
.fern/metadata.json | 2 +-
poetry.lock | 6 +-
reference.md | 1570 ++++++-----------
src/whop_sdk/__init__.py | 195 +-
src/whop_sdk/access_tokens/client.py | 4 +-
src/whop_sdk/account_links/client.py | 4 +-
src/whop_sdk/accounts/client.py | 42 +-
src/whop_sdk/accounts/preferences/client.py | 8 +-
src/whop_sdk/accounts/raw_client.py | 10 +
src/whop_sdk/accounts/reserves/client.py | 4 +-
src/whop_sdk/ad_campaigns/__init__.py | 63 +
src/whop_sdk/ad_campaigns/client.py | 40 +-
src/whop_sdk/ad_campaigns/raw_client.py | 4 +-
src/whop_sdk/ad_campaigns/types/__init__.py | 75 +
...post_ad_campaign_payment_failed_payload.py | 4 +-
...ad_campaign_payment_failed_payload_data.py | 101 ++
...gn_payment_failed_payload_data_bid_type.py | 7 +
...failed_payload_data_budget_optimization.py | 7 +
...payment_failed_payload_data_budget_type.py | 5 +
...ent_failed_payload_data_delivery_status.py | 21 +
...n_payment_failed_payload_data_objective.py | 7 +
...gn_payment_failed_payload_data_platform.py | 5 +
...payload_data_special_ad_categories_item.py | 7 +
...aign_payment_failed_payload_data_status.py | 21 +
.../types/post_ad_campaign_updated_payload.py | 57 +
...ad_campaign_updated_payload_api_version.py | 5 +
.../post_ad_campaign_updated_payload_data.py | 99 ++
..._campaign_updated_payload_data_bid_type.py | 7 +
...pdated_payload_data_budget_optimization.py | 5 +
...mpaign_updated_payload_data_budget_type.py | 5 +
...gn_updated_payload_data_delivery_status.py | 21 +
...campaign_updated_payload_data_objective.py | 7 +
..._campaign_updated_payload_data_platform.py | 5 +
...payload_data_special_ad_categories_item.py | 7 +
...ad_campaign_updated_payload_data_status.py | 21 +
.../post_ad_campaign_updated_payload_type.py | 5 +
src/whop_sdk/ad_groups/client.py | 40 +-
src/whop_sdk/ads/__init__.py | 24 +
src/whop_sdk/ads/client.py | 36 +-
src/whop_sdk/ads/raw_client.py | 4 +-
src/whop_sdk/ads/types/__init__.py | 24 +
.../ads/types/post_ad_updated_payload.py | 57 +
.../post_ad_updated_payload_api_version.py | 5 +
.../ads/types/post_ad_updated_payload_data.py | 133 ++
..._ad_updated_payload_data_call_to_action.py | 40 +
...ad_updated_payload_data_delivery_status.py | 21 +
...ost_ad_updated_payload_data_post_source.py | 5 +
.../post_ad_updated_payload_data_status.py | 5 +
.../ads/types/post_ad_updated_payload_type.py | 5 +
src/whop_sdk/affiliates/client.py | 20 +-
src/whop_sdk/affiliates/overrides/client.py | 20 +-
src/whop_sdk/ai_chats/client.py | 39 +-
src/whop_sdk/ai_chats/raw_client.py | 21 +
src/whop_sdk/api_keys/client.py | 28 +-
...reate_api_keys_request_api_version_date.py | 2 +
...pdate_api_keys_request_api_version_date.py | 2 +
src/whop_sdk/api_logs/client.py | 4 +-
src/whop_sdk/app_builds/client.py | 16 +-
src/whop_sdk/apps/__init__.py | 3 -
src/whop_sdk/apps/client.py | 153 +-
src/whop_sdk/apps/raw_client.py | 288 ---
src/whop_sdk/apps/types/__init__.py | 5 -
..._app_request_requested_permissions_item.py | 36 -
src/whop_sdk/audiences/__init__.py | 9 +
src/whop_sdk/audiences/client.py | 112 +-
src/whop_sdk/audiences/raw_client.py | 89 +-
src/whop_sdk/audiences/types/__init__.py | 9 +
...create_audiences_request_column_mapping.py | 2 +-
.../create_audiences_request_engagement.py | 38 +
...e_audiences_request_engagement_platform.py | 5 +
.../create_audiences_request_source_type.py | 5 +
.../list_audiences_request_source_type.py | 2 +-
src/whop_sdk/authorized_users/client.py | 16 +-
src/whop_sdk/bounties/client.py | 20 +-
src/whop_sdk/bounties/submissions/client.py | 8 +-
src/whop_sdk/bounty_submissions/client.py | 20 +-
src/whop_sdk/card_transactions/client.py | 8 +-
src/whop_sdk/cards/__init__.py | 3 +
src/whop_sdk/cards/client.py | 31 +-
src/whop_sdk/cards/raw_client.py | 19 +-
src/whop_sdk/cards/types/__init__.py | 3 +
.../types/update_cards_request_billing.py | 6 +-
.../types/update_cards_request_cardholder.py | 41 +
src/whop_sdk/chat_channels/client.py | 12 +-
.../checkout_configurations/client.py | 16 +-
src/whop_sdk/client.py | 8 +-
.../company_token_transactions/client.py | 12 +-
src/whop_sdk/confirmation_tokens/__init__.py | 3 +
src/whop_sdk/confirmation_tokens/client.py | 8 +-
.../confirmation_tokens/types/__init__.py | 5 +
...irmation_tokens_request_billing_details.py | 1 +
...firmation_tokens_request_payment_method.py | 8 +
...tokens_request_payment_method_redirect.py} | 9 +-
src/whop_sdk/course_chapters/client.py | 20 +-
.../course_lesson_interactions/client.py | 8 +-
src/whop_sdk/course_lessons/client.py | 32 +-
src/whop_sdk/course_students/client.py | 8 +-
src/whop_sdk/courses/client.py | 20 +-
src/whop_sdk/deposits/client.py | 12 +-
src/whop_sdk/deposits/raw_client.py | 8 +-
.../types/create_deposits_response_methods.py | 2 +-
src/whop_sdk/dispute_alerts/client.py | 8 +-
src/whop_sdk/disputes/__init__.py | 12 -
src/whop_sdk/disputes/client.py | 393 +----
src/whop_sdk/disputes/raw_client.py | 734 --------
src/whop_sdk/disputes/types/__init__.py | 20 -
..._request_cancellation_policy_attachment.py | 26 -
...quest_customer_communication_attachment.py | 26 -
src/whop_sdk/dm_channels/client.py | 20 +-
src/whop_sdk/dm_members/client.py | 20 +-
src/whop_sdk/entries/client.py | 16 +-
src/whop_sdk/events/client.py | 16 +-
..._data_item_related_audience_source_type.py | 2 +-
src/whop_sdk/experiences/client.py | 32 +-
src/whop_sdk/exports/client.py | 12 +-
src/whop_sdk/fee_markups/client.py | 12 +-
src/whop_sdk/files/client.py | 16 +-
src/whop_sdk/financial_activity/client.py | 4 +-
.../financial_reports/breakdown/client.py | 4 +-
src/whop_sdk/financial_reports/client.py | 4 +-
...ial_reports_response_rows_item_grouping.py | 1 +
...eports_response_rows_item_line_category.py | 1 +
src/whop_sdk/forum_posts/client.py | 16 +-
src/whop_sdk/forums/client.py | 12 +-
src/whop_sdk/identity_profiles/client.py | 16 +-
src/whop_sdk/invoices/client.py | 36 +-
src/whop_sdk/leads/client.py | 16 +-
src/whop_sdk/ledger_accounts/client.py | 4 +-
src/whop_sdk/media/client.py | 8 +-
src/whop_sdk/members/client.py | 8 +-
src/whop_sdk/members/logs/client.py | 4 +-
src/whop_sdk/memberships/client.py | 273 +--
src/whop_sdk/memberships/raw_client.py | 736 +-------
src/whop_sdk/messages/client.py | 20 +-
src/whop_sdk/notifications/client.py | 20 +-
src/whop_sdk/notifications/topics/client.py | 4 +-
src/whop_sdk/partners/businesses/client.py | 8 +-
.../partners/businesses/earnings/client.py | 4 +-
.../types/list_businesses_request_order.py | 8 +-
...usinesses_response_data_item_volume_usd.py | 14 +
...retrieve_businesses_response_volume_usd.py | 14 +
src/whop_sdk/partners/client.py | 103 +-
src/whop_sdk/partners/raw_client.py | 124 ++
src/whop_sdk/payment_method_domains/client.py | 24 +-
.../payment_method_domains/raw_client.py | 4 +-
src/whop_sdk/payment_methods/client.py | 12 +-
src/whop_sdk/payments/client.py | 116 +-
src/whop_sdk/payments/raw_client.py | 196 ++
.../types/post_payment_authorized_payload.py | 4 +-
.../types/post_payment_canceled_payload.py | 4 +-
.../types/post_payment_created_payload.py | 4 +-
.../types/post_payment_failed_payload.py | 4 +-
.../types/post_payment_pending_payload.py | 4 +-
.../types/post_payment_succeeded_payload.py | 4 +-
src/whop_sdk/payout_accounts/client.py | 4 +-
src/whop_sdk/payout_methods/client.py | 8 +-
src/whop_sdk/payouts/client.py | 20 +-
src/whop_sdk/payouts/methods/client.py | 16 +-
.../payouts/supported_methods/client.py | 4 +-
src/whop_sdk/people/client.py | 8 +-
src/whop_sdk/permissions/client.py | 4 +-
src/whop_sdk/plans/client.py | 44 +-
src/whop_sdk/plans/raw_client.py | 20 +-
src/whop_sdk/products/client.py | 32 +-
src/whop_sdk/products/raw_client.py | 4 +-
src/whop_sdk/promo_codes/client.py | 24 +-
src/whop_sdk/reactions/client.py | 16 +-
src/whop_sdk/recommended_actions/client.py | 16 +-
src/whop_sdk/refunds/client.py | 8 +-
.../resolution_center_cases/client.py | 44 +-
src/whop_sdk/reviews/client.py | 8 +-
src/whop_sdk/setup_intents/client.py | 20 +-
src/whop_sdk/shipments/client.py | 16 +-
src/whop_sdk/social_accounts/client.py | 24 +-
src/whop_sdk/stats/client.py | 20 +-
src/whop_sdk/support_channels/client.py | 12 +-
src/whop_sdk/swaps/client.py | 16 +-
src/whop_sdk/team_members/client.py | 20 +-
src/whop_sdk/topups/client.py | 4 +-
src/whop_sdk/transfers/__init__.py | 3 +
src/whop_sdk/transfers/client.py | 37 +-
src/whop_sdk/transfers/raw_client.py | 21 +
src/whop_sdk/transfers/types/__init__.py | 3 +
.../create_transfers_request_feed_type.py | 7 +
src/whop_sdk/types/__init__.py | 68 +
.../types/account_required_action_action.py | 1 +
src/whop_sdk/types/ai_chat.py | 6 +
.../types/ai_chat_agent_identifiers.py | 5 +
src/whop_sdk/types/ai_chat_list_item.py | 6 +
.../types/api_key_api_version_date.py | 2 +
src/whop_sdk/types/audience.py | 22 +-
src/whop_sdk/types/audience_engagement.py | 34 +
.../audience_engagement_facebook_page_rule.py | 33 +
...nce_engagement_facebook_page_rule_event.py | 7 +
...ience_engagement_instagram_profile_rule.py | 33 +
...engagement_instagram_profile_rule_event.py | 26 +
.../audience_engagement_lead_form_rule.py | 34 +
...udience_engagement_lead_form_rule_event.py | 5 +
.../types/audience_engagement_platform.py | 5 +
.../types/audience_engagement_rule.py | 90 +
.../types/audience_engagement_video_rule.py | 34 +
.../audience_engagement_video_rule_event.py | 16 +
src/whop_sdk/types/audience_source_type.py | 2 +-
.../types/checkout_configuration_list_item.py | 5 +
src/whop_sdk/types/fee_markup_types.py | 2 +
.../types/ledger_activity_line_type.py | 5 +
src/whop_sdk/types/onboarding_reward.py | 89 +
...ding_reward_qualification_income_source.py | 5 +
.../types/onboarding_reward_reward_type.py | 5 +
.../types/onboarding_reward_status.py | 7 +
src/whop_sdk/types/payment.py | 5 +
src/whop_sdk/types/payment_legacy.py | 5 +
src/whop_sdk/types/payment_method_types.py | 8 +
src/whop_sdk/types/permission_action.py | 1 +
.../recommended_action.py} | 10 +-
src/whop_sdk/types/resolution_center_case.py | 2 +
src/whop_sdk/types/resolution_line_item.py | 42 +
src/whop_sdk/types/social_account_post.py | 10 +
src/whop_sdk/types/support_channel.py | 5 +
.../types/support_channel_list_item.py | 5 +
src/whop_sdk/types/webhook_event.py | 2 +
src/whop_sdk/types/webhook_events_item.py | 2 +
.../types/webhook_list_item_events_item.py | 2 +
.../types/webhook_testable_events_item.py | 2 +
src/whop_sdk/users/client.py | 28 +-
src/whop_sdk/users/oauth_grants/client.py | 8 +-
src/whop_sdk/users/passkeys/client.py | 16 +-
src/whop_sdk/users/preferences/client.py | 8 +-
.../users/preferences/notifications/client.py | 8 +-
.../notifications/experiences/client.py | 4 +-
.../preferences/notifications/raw_client.py | 4 +-
.../notifications/topics/client.py | 4 +-
...ications_request_preferences_item_scope.py | 2 +-
src/whop_sdk/verifications/client.py | 16 +-
src/whop_sdk/webhooks/__init__.py | 9 -
src/whop_sdk/webhooks/client.py | 177 +-
src/whop_sdk/webhooks/raw_client.py | 332 ----
src/whop_sdk/webhooks/types/__init__.py | 9 -
.../create_webhooks_request_events_item.py | 2 +
.../types/deliveries_webhook_response.py | 33 -
.../deliveries_webhook_response_data_item.py | 52 -
.../deliveries_webhook_response_page_info.py | 31 -
.../update_webhooks_request_events_item.py | 2 +
243 files changed, 4130 insertions(+), 5079 deletions(-)
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_bid_type.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_budget_optimization.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_budget_type.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_delivery_status.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_objective.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_platform.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_special_ad_categories_item.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_status.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_api_version.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_bid_type.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_budget_optimization.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_budget_type.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_delivery_status.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_objective.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_platform.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_special_ad_categories_item.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_status.py
create mode 100644 src/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_type.py
create mode 100644 src/whop_sdk/ads/types/post_ad_updated_payload.py
create mode 100644 src/whop_sdk/ads/types/post_ad_updated_payload_api_version.py
create mode 100644 src/whop_sdk/ads/types/post_ad_updated_payload_data.py
create mode 100644 src/whop_sdk/ads/types/post_ad_updated_payload_data_call_to_action.py
create mode 100644 src/whop_sdk/ads/types/post_ad_updated_payload_data_delivery_status.py
create mode 100644 src/whop_sdk/ads/types/post_ad_updated_payload_data_post_source.py
create mode 100644 src/whop_sdk/ads/types/post_ad_updated_payload_data_status.py
create mode 100644 src/whop_sdk/ads/types/post_ad_updated_payload_type.py
delete mode 100644 src/whop_sdk/apps/types/update_permissions_app_request_requested_permissions_item.py
create mode 100644 src/whop_sdk/audiences/types/create_audiences_request_engagement.py
create mode 100644 src/whop_sdk/audiences/types/create_audiences_request_engagement_platform.py
create mode 100644 src/whop_sdk/audiences/types/create_audiences_request_source_type.py
create mode 100644 src/whop_sdk/cards/types/update_cards_request_cardholder.py
rename src/whop_sdk/{disputes/types/update_evidence_dispute_request_refund_policy_attachment.py => confirmation_tokens/types/create_confirmation_tokens_request_payment_method_redirect.py} (67%)
delete mode 100644 src/whop_sdk/disputes/types/update_evidence_dispute_request_cancellation_policy_attachment.py
delete mode 100644 src/whop_sdk/disputes/types/update_evidence_dispute_request_customer_communication_attachment.py
create mode 100644 src/whop_sdk/transfers/types/create_transfers_request_feed_type.py
create mode 100644 src/whop_sdk/types/ai_chat_agent_identifiers.py
create mode 100644 src/whop_sdk/types/audience_engagement.py
create mode 100644 src/whop_sdk/types/audience_engagement_facebook_page_rule.py
create mode 100644 src/whop_sdk/types/audience_engagement_facebook_page_rule_event.py
create mode 100644 src/whop_sdk/types/audience_engagement_instagram_profile_rule.py
create mode 100644 src/whop_sdk/types/audience_engagement_instagram_profile_rule_event.py
create mode 100644 src/whop_sdk/types/audience_engagement_lead_form_rule.py
create mode 100644 src/whop_sdk/types/audience_engagement_lead_form_rule_event.py
create mode 100644 src/whop_sdk/types/audience_engagement_platform.py
create mode 100644 src/whop_sdk/types/audience_engagement_rule.py
create mode 100644 src/whop_sdk/types/audience_engagement_video_rule.py
create mode 100644 src/whop_sdk/types/audience_engagement_video_rule_event.py
create mode 100644 src/whop_sdk/types/onboarding_reward.py
create mode 100644 src/whop_sdk/types/onboarding_reward_qualification_income_source.py
create mode 100644 src/whop_sdk/types/onboarding_reward_reward_type.py
create mode 100644 src/whop_sdk/types/onboarding_reward_status.py
rename src/whop_sdk/{disputes/types/update_evidence_dispute_request_uncategorized_attachment.py => types/recommended_action.py} (60%)
create mode 100644 src/whop_sdk/types/resolution_line_item.py
delete mode 100644 src/whop_sdk/webhooks/types/deliveries_webhook_response.py
delete mode 100644 src/whop_sdk/webhooks/types/deliveries_webhook_response_data_item.py
delete mode 100644 src/whop_sdk/webhooks/types/deliveries_webhook_response_page_info.py
diff --git a/.fern/metadata.json b/.fern/metadata.json
index ab0ed37d..838d833a 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -15,7 +15,7 @@
"standardwebhooks": ">=1.0.1,<2"
}
},
- "originGitCommit": "aca262b24a27e2e67026e2661c5b9d2fe8e9a016",
+ "originGitCommit": "eeac8887765f8f6903e379851ca01e253b9af648",
"originGitCommitIsDirty": false,
"invokedBy": "ci",
"requestedVersion": "1.1.1",
diff --git a/poetry.lock b/poetry.lock
index b55c24cf..196c03a4 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -188,14 +188,14 @@ files = [
[[package]]
name = "anyio"
-version = "4.15.0"
+version = "4.15.1"
description = "High-level concurrency and networking framework on top of asyncio or Trio"
optional = false
python-versions = ">=3.10"
groups = ["main"]
files = [
- {file = "anyio-4.15.0-py3-none-any.whl", hash = "sha256:7ecd9937369ffce8bba0b5ccb9b3a9507b101b0ed50256aecfbab27e6c2acb99"},
- {file = "anyio-4.15.0.tar.gz", hash = "sha256:b5c620ed540725e2579c31b17bb995b3bf02c9281c9cace04c7d186380bab85e"},
+ {file = "anyio-4.15.1-py3-none-any.whl", hash = "sha256:6152fdbbf9a77fdec97731721bebf7c4c44f7c29b424b0065826173efc7ed101"},
+ {file = "anyio-4.15.1.tar.gz", hash = "sha256:9f28306018cbd6d329e64a36d58256edff76dd996fe423bc957326e578b82a94"},
]
[package.dependencies]
diff --git a/reference.md b/reference.md
index 04e662c8..bdb65906 100644
--- a/reference.md
+++ b/reference.md
@@ -455,6 +455,14 @@ client.accounts.create()
-
+**send_customer_emails:** `typing.Optional[bool]` — Whether Whop sends transactional emails to customers on behalf of the connected account.
+
+
+
+
+
+-
+
**title:** `typing.Optional[str]` — The display name of the account. Defaults to `metadata.external_id` or the owner's email when omitted.
@@ -2308,7 +2316,7 @@ client.ad_campaigns.retry_payment(
-
-Resumes a paused ad campaign.
+Resumes a paused ad campaign. Requires an ads payment method on the account.
@@ -3999,7 +4007,7 @@ client.ads.list(
-
-Creates an ad in an ad group.
+Creates an ad in an ad group. Any campaign status other than `draft` launches the campaign, which requires an ads payment method on the account.
@@ -5359,6 +5367,14 @@ client.ai_chats.list(
-
+**agent_identifier:** `typing.Optional[AiChatAgentIdentifiers]`
+
+
+
+
+
+-
+
**only_active_crons:** `typing.Optional[bool]` — When true, returns only chats with an active cron schedule
@@ -5443,6 +5459,14 @@ client.ai_chats.create(
-
+**agent_identifier:** `typing.Optional[AiChatAgentIdentifiers]` — The AI agent that handles the chat. Defaults to `support`.
+
+
+
+
+
+-
+
**current_account_id:** `typing.Optional[str]` — The unique identifier of the account to set as context for the AI chat (e.g., "biz_XXXXX").
@@ -7256,98 +7280,6 @@ client.apps.create(
-
-
-
-
-client.apps.update_permissions_app(...) -> bool
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Updates the permission requirements for an app
-
-Required permissions:
- - `developer:update_app_authorization`
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from whop_sdk import Whop
-from whop_sdk.environment import WhopEnvironment
-from whop_sdk.apps import UpdatePermissionsAppRequestRequestedPermissionsItem
-
-client = Whop(
- token="",
- environment=WhopEnvironment.DEFAULT,
-)
-
-client.apps.update_permissions_app(
- app_id="app_id",
- requested_permissions=[
- UpdatePermissionsAppRequestRequestedPermissionsItem(
- action="action",
- is_required=True,
- justification="justification",
- )
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**app_id:** `str` — The ID of the app the permission requirements are being updated for
-
-
-
-
-
--
-
-**requested_permissions:** `typing.List[UpdatePermissionsAppRequestRequestedPermissionsItem]` — The permissions that the app will request off of users when a user installs the app.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-Lists uploaded customer-list audiences for an account. Pass `audience_id` to return a specific audience.
+List custom and lookalike audiences for an account. Pass `audience_id` to return a specific audience.
@@ -8108,7 +8040,7 @@ client.audiences.list(
-
-**audience_type:** `typing.Optional[ListAudiencesRequestAudienceType]` — Filter by audience type: `custom` (uploaded lists) or `lookalike`.
+**audience_type:** `typing.Optional[ListAudiencesRequestAudienceType]` — Filter by custom or lookalike audiences.
@@ -8116,7 +8048,7 @@ client.audiences.list(
-
-**source_type:** `typing.Optional[ListAudiencesRequestSourceType]` — Filter by member source: `csv_upload` (uploaded lists) or `people_filter` (automatic audiences built from saved People filters).
+**source_type:** `typing.Optional[ListAudiencesRequestSourceType]` — Filter by uploaded customer lists, Whop People filters, or social engagement.
@@ -8164,152 +8096,181 @@ client.audiences.list(
-
-Creates an audience. Default (`audience_type` omitted or `custom`): creates one audience from an uploaded customer identity CSV file (`name`, `column_mapping`, and `file_id` required) and starts processing it; responds with the audience object. With `filters`: creates an audience from saved People filters (`name` required) — membership is built from the account's People data, and `auto_refresh` decides whether it keeps tracking the filters or keeps whoever matched at creation. With `audience_type: lookalike`: creates a ladder of Meta lookalike audiences from an existing ready custom audience (`source_audience_id`, `count`, and `percentage` required) — `count` equal similarity bands slicing the top `percentage`% (3 audiences at 6% = 0–2%, 2–4%, 4–6%), each returned as its own audience in a `{ data: [...] }` envelope.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from whop_sdk import Whop
-from whop_sdk.environment import WhopEnvironment
-
-client = Whop(
- token="",
- environment=WhopEnvironment.DEFAULT,
-)
-
-client.audiences.create(
- account_id="biz_xxxxxxxxxxxxxx",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**account_id:** `str` — Account ID, prefixed `biz_`.
-
-
-
-
-
--
-
-**audience_type:** `typing.Optional[CreateAudiencesRequestAudienceType]` — What to create. Defaults to `custom` (CSV upload).
-
-
-
-
-
--
-
-**auto_refresh:** `typing.Optional[bool]` — Filter audiences only, and set only at creation. `true` (the default) rebuilds membership from the filters twice a day. `false` keeps whoever matched at creation and never rebuilds.
-
-
-
-
-
--
-
-**column_mapping:** `typing.Optional[CreateAudiencesRequestColumnMapping]` — Custom audiences only. Maps supported identity fields to CSV column headers. Map at least one of `email` or `phone`.
-
-
-
-
-
--
-
-**count:** `typing.Optional[int]` — Lookalikes only. Number of lookalike audiences to create (1–6).
-
-
-
-
-
--
-
-**file_id:** `typing.Optional[str]` — Custom audiences only. The uploaded customer CSV — a file id (`file_...`) returned by `POST /files`.
-
-
-
-
-
--
-
-**filters:** `typing.Optional[typing.Dict[str, typing.Any]]` — Filter audiences only. The People filters that define membership, keyed exactly as `GET /people` accepts them — for example `{"os": "iOS", "country": "US"}`. Date filters must be rolling windows — `first_seen_within_days` or `last_seen_within_days` — so the audience re-anchors on every refresh; fixed dates such as `first_seen_after` are rejected. Source values are canonical source paths (`whop:::`, `ext::...`, `referrer:`, `direct`), exact or with a trailing `:*` wildcard.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — Audience display name. Required for custom audiences; lookalike names are generated from the source audience.
-
-
-
-
-
--
-
-**percentage:** `typing.Optional[int]` — Lookalikes only. Total similarity reach as a whole percent (1–20), sliced evenly across `count` — must be divisible by `count`.
-
-
-
-
-
--
-
-**source_audience_id:** `typing.Optional[str]` — Lookalikes only. The ready custom audience (`adaud_`) to build from; it needs at least 100 matched people.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.audiences.delete(...) -> DeleteAudiencesResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes an audience so it is no longer available for targeting.
+Create an audience from a customer list, your account's Whop People data, or engagement with videos, lead forms, Instagram profiles, or Facebook pages. Create lookalike audiences to reach people similar to an existing audience. Processing runs asynchronously. Custom creation returns one audience; lookalike creation returns the requested similarity bands in `data`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from whop_sdk import Whop, AudienceEngagementRule_FacebookPage
+from whop_sdk.environment import WhopEnvironment
+from whop_sdk.audiences import CreateAudiencesRequestEngagement
+
+client = Whop(
+ token="",
+ environment=WhopEnvironment.DEFAULT,
+)
+
+client.audiences.create(
+ account_id="biz_xxxxxxxxxxxxxx",
+ engagement=CreateAudiencesRequestEngagement(
+ include=[
+ AudienceEngagementRule_FacebookPage(
+ event="engaged",
+ retention_days=30,
+ social_account_id="sacc_xxxxxxxxxxxxxx",
+ )
+ ],
+ platform="meta",
+ ),
+ name="Page engagers",
+ source_type="engagement",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_id:** `str` — Account ID, prefixed `biz_`.
+
+
+
+
+
+-
+
+**audience_type:** `typing.Optional[CreateAudiencesRequestAudienceType]` — Audience type. Defaults to `custom`.
+
+
+
+
+
+-
+
+**auto_refresh:** `typing.Optional[bool]` — Filter audiences only, and set only at creation. `true` (the default) rebuilds membership from the filters twice a day. `false` keeps whoever matched at creation and never rebuilds.
+
+
+
+
+
+-
+
+**column_mapping:** `typing.Optional[CreateAudiencesRequestColumnMapping]` — CSV audiences only. Maps supported identity fields to CSV column headers. Map at least one of `email` or `phone`.
+
+
+
+
+
+-
+
+**count:** `typing.Optional[int]` — Lookalikes only. Number of lookalike audiences to create (1–6).
+
+
+
+
+
+-
+
+**engagement:** `typing.Optional[CreateAudiencesRequestEngagement]` — Rules for membership based on social engagement. Requires a connected social account with advertising access.
+
+
+
+
+
+-
+
+**file_id:** `typing.Optional[str]` — CSV audiences only. The uploaded customer CSV — a file id (`file_...`) returned by `POST /files`.
+
+
+
+
+
+-
+
+**filters:** `typing.Optional[typing.Dict[str, typing.Any]]` — Filter audiences only. The People filters that define membership, keyed exactly as `GET /people` accepts them — for example `{"os": "iOS", "country": "US"}`. Date filters must be rolling windows — `first_seen_within_days` or `last_seen_within_days` — so the audience re-anchors on every refresh; fixed dates such as `first_seen_after` are rejected. Source values are canonical source paths (`whop:::`, `ext::...`, `referrer:`, `direct`), exact or with a trailing `:*` wildcard.
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — Audience display name. Required for custom audiences; lookalike names are generated from the source audience.
+
+
+
+
+
+-
+
+**percentage:** `typing.Optional[int]` — Lookalikes only. Total similarity reach as a whole percent (1–20), sliced evenly across `count` — must be divisible by `count`. For example, 3 audiences at 6% creates 0–2%, 2–4%, and 4–6% bands.
+
+
+
+
+
+-
+
+**source_audience_id:** `typing.Optional[str]` — Lookalikes only. The ready custom audience (`adaud_`) to build from; uploaded and People audiences need at least 100 matched people. Meta validates engagement audience eligibility when creating the lookalike.
+
+
+
+
+
+-
+
+**source_type:** `typing.Optional[CreateAudiencesRequestSourceType]` — Custom audience source. Inferred from `engagement`, then `filters`, otherwise defaults to `csv_upload`. Supply only the fields for the selected source.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.audiences.delete(...) -> DeleteAudiencesResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes an audience so it is no longer available for targeting.
@@ -10716,7 +10677,7 @@ client.cards.update(
-
-**billing:** `typing.Optional[UpdateCardsRequestBilling]` — New billing address. Requires line1, city, region, postal_code, and country_code. On an invited card, passing billing alone (as the invited user) completes onboarding and starts card provisioning.
+**billing:** `typing.Optional[UpdateCardsRequestBilling]` — The billing address. On an issued card this replaces the card's billing address and region is also required. On an invited card, sending it as the invited user completes onboarding and starts card provisioning.
@@ -10732,6 +10693,14 @@ client.cards.update(
-
+**cardholder:** `typing.Optional[UpdateCardsRequestCardholder]` — Details for the invited cardholder, accepted only while completing onboarding on an invited card. The legal name comes from an approved identity verification when the invited user has one, and from these fields when they do not.
+
+
+
+
+
+-
+
**frozen:** `typing.Optional[bool]` — Pass `true` to freeze the card, `false` to unfreeze it. The assigned cardholder may freeze their own card without the payout:account:update scope.
@@ -14303,7 +14272,7 @@ client.courses.update(
-
-Retrieve the deposit methods for an account, including crypto and bank transfer.
+Retrieve the deposit methods for an account, including crypto and bank transfer. Crypto deposits require a $10 minimum.
@@ -14352,7 +14321,7 @@ client.deposits.create(
-
-**amount:** `typing.Optional[float]` — Amount to prefill on hosted deposit page.
+**amount:** `typing.Optional[float]` — Amount to prefill on hosted deposit page. Crypto deposits require a $10 minimum.
@@ -15083,284 +15052,6 @@ client.disputes.submit(
-
-
-client.disputes.submit_evidence_dispute(...) -> DisputeLegacy
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Submit a payment dispute to the payment processor for review. Once submitted, no further edits can be made.
-
-Required permissions:
- - `payment:dispute`
- - `plan:basic:read`
- - `access_pass:basic:read`
- - `company:basic:read`
- - `payment:basic:read`
- - `member:email:read`
- - `member:basic:read`
- - `member:phone:read`
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from whop_sdk import Whop
-from whop_sdk.environment import WhopEnvironment
-
-client = Whop(
- token="",
- environment=WhopEnvironment.DEFAULT,
-)
-
-client.disputes.submit_evidence_dispute(
- id="dspt_xxxxxxxxxxxxx",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — The unique identifier of the dispute to submit to the payment processor for review.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.disputes.update_evidence_dispute(...) -> DisputeLegacy
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update a dispute with evidence data to attempt to win the dispute.
-
-Required permissions:
- - `payment:dispute`
- - `plan:basic:read`
- - `access_pass:basic:read`
- - `company:basic:read`
- - `payment:basic:read`
- - `member:email:read`
- - `member:basic:read`
- - `member:phone:read`
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from whop_sdk import Whop
-from whop_sdk.environment import WhopEnvironment
-
-client = Whop(
- token="",
- environment=WhopEnvironment.DEFAULT,
-)
-
-client.disputes.update_evidence_dispute(
- id="dspt_xxxxxxxxxxxxx",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — The unique identifier of the dispute to update.
-
-
-
-
-
--
-
-**access_activity_log:** `typing.Optional[str]` — An IP access activity log showing the customer used the service.
-
-
-
-
-
--
-
-**billing_address:** `typing.Optional[str]` — The billing address associated with the customer's payment method.
-
-
-
-
-
--
-
-**cancellation_policy_attachment:** `typing.Optional[UpdateEvidenceDisputeRequestCancellationPolicyAttachment]` — A file upload containing the company's cancellation policy document.
-
-
-
-
-
--
-
-**cancellation_policy_disclosure:** `typing.Optional[str]` — The company's cancellation policy text to submit as evidence.
-
-
-
-
-
--
-
-**customer_communication_attachment:** `typing.Optional[UpdateEvidenceDisputeRequestCustomerCommunicationAttachment]` — A file upload containing evidence of customer communication. Must be a JPEG, PNG, GIF, or PDF.
-
-
-
-
-
--
-
-**customer_email_address:** `typing.Optional[str]` — The email address of the customer associated with the disputed payment.
-
-
-
-
-
--
-
-**customer_name:** `typing.Optional[str]` — The full name of the customer associated with the disputed payment.
-
-
-
-
-
--
-
-**notes:** `typing.Optional[str]` — Additional notes or context to submit as part of the dispute evidence.
-
-
-
-
-
--
-
-**product_description:** `typing.Optional[str]` — A description of the product or service that was provided to the customer.
-
-
-
-
-
--
-
-**refund_policy_attachment:** `typing.Optional[UpdateEvidenceDisputeRequestRefundPolicyAttachment]` — A file upload containing the company's refund policy document.
-
-
-
-
-
--
-
-**refund_policy_disclosure:** `typing.Optional[str]` — The company's refund policy text to submit as evidence.
-
-
-
-
-
--
-
-**refund_refusal_explanation:** `typing.Optional[str]` — An explanation of why the refund request was refused.
-
-
-
-
-
--
-
-**service_date:** `typing.Optional[str]` — The date when the product or service was delivered to the customer.
-
-
-
-
-
--
-
-**uncategorized_attachment:** `typing.Optional[UpdateEvidenceDisputeRequestUncategorizedAttachment]` — A file upload for evidence that does not fit into the other categories.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
client.memberships.add_free_days_membership(...) -> MembershipLegacy
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Add free days to extend a membership's current billing period, expiration date, or Stripe trial.
-
-Required permissions:
- - `member:manage`
- - `member:email:read`
- - `member:basic:read`
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from whop_sdk import Whop
-from whop_sdk.environment import WhopEnvironment
-
-client = Whop(
- token="",
- environment=WhopEnvironment.DEFAULT,
-)
-
-client.memberships.add_free_days_membership(
- id="mem_xxxxxxxxxxxxxx",
- free_days=42,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str` — The unique identifier of the membership.
-
-
-
-
-
--
-
-**free_days:** `int` — The number of free days to add (1-1095). Extends the billing period, expiration date, or Stripe trial depending on plan type.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
client.memberships.resync_access_membership(...) -> MembershipLegacy
+client.memberships.resync_access(...) -> Membership
-
@@ -23407,12 +23011,7 @@ client.memberships.resume(
-
-Re-run access fulfillment for a membership. Recomputes the member's content access on Whop, re-validates their Discord link (re-adding them to the server and re-assigning roles if needed), and re-fulfills TradingView indicator access. Telegram access is invite-based and cannot be resynced here. The outcome is written to the membership's logs.
-
-Required permissions:
- - `membership:resync_access`
- - `member:email:read`
- - `member:basic:read`
+Re-runs access fulfillment for a membership: recomputes the member's content access on Whop, re-validates their Discord link (re-adding them to the server and re-assigning roles if needed), and re-fulfills TradingView indicator access. Telegram access is invite-based and is not resynced. The work runs in the background and the outcome is written to the membership's logs.
@@ -23435,8 +23034,8 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.memberships.resync_access_membership(
- id="mem_xxxxxxxxxxxxxx",
+client.memberships.resync_access(
+ id="id",
)
```
@@ -23453,7 +23052,7 @@ client.memberships.resync_access_membership(
-
-**id:** `str` — The unique identifier of the membership to resync access for.
+**id:** `str` — Membership ID (`mem_` tag).
@@ -23546,7 +23145,8 @@ client.memberships.transfer(
client.memberships.uncancel_membership(...) -> MembershipLegacy
+## Messages
+client.messages.list(...) -> ListMessagesResponse
-
@@ -23558,12 +23158,12 @@ client.memberships.transfer(
-
-Reverse a pending cancellation for a membership that was scheduled to cancel at period end.
+Returns a paginated list of messages within a specific experience chat, DM, or group chat channel, sorted by creation time.
-Required permissions:
- - `member:manage`
- - `member:email:read`
- - `member:basic:read`
+Required permissions (one of):
+ - `chat:read`
+ - `dms:read`
+ - `support_chat:read`
@@ -23586,8 +23186,10 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.memberships.uncancel_membership(
- id="mem_xxxxxxxxxxxxxx",
+client.messages.list(
+ first=42,
+ last=42,
+ channel_id="channel_id",
)
```
@@ -23604,7 +23206,47 @@ client.memberships.uncancel_membership(
-
-**id:** `str` — The unique identifier of the membership to uncancel.
+**channel_id:** `str` — The unique identifier of the channel or experience to list messages for.
+
+
+
+
+
+-
+
+**after:** `typing.Optional[str]` — Returns the elements in the list that come after the specified cursor.
+
+
+
+
+
+-
+
+**before:** `typing.Optional[str]` — Returns the elements in the list that come before the specified cursor.
+
+
+
+
+
+-
+
+**first:** `typing.Optional[int]` — Returns the first _n_ elements from the list.
+
+
+
+
+
+-
+
+**last:** `typing.Optional[int]` — Returns the last _n_ elements from the list.
+
+
+
+
+
+-
+
+**direction:** `typing.Optional[Direction]`
@@ -23624,8 +23266,7 @@ client.memberships.uncancel_membership(
client.messages.list(...) -> ListMessagesResponse
+client.messages.create(...) -> Message
-
@@ -23637,12 +23278,13 @@ client.memberships.uncancel_membership(
-
-Returns a paginated list of messages within a specific experience chat, DM, or group chat channel, sorted by creation time.
+Send a new message in an experience chat, DM, or group chat channel. Supports text content, attachments, polls, and replies.
Required permissions (one of):
- - `chat:read`
- - `dms:read`
- - `support_chat:read`
+ - `chat:message:create`
+ - `dms:message:manage`
+ - `livestream:chat:write`
+ - `support_chat:message:create`
@@ -23665,10 +23307,9 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.messages.list(
- first=42,
- last=42,
+client.messages.create(
channel_id="channel_id",
+ content="content",
)
```
@@ -23685,7 +23326,7 @@ client.messages.list(
-
-**channel_id:** `str` — The unique identifier of the channel or experience to list messages for.
+**channel_id:** `str` — The unique identifier of the channel or experience to send the message in. For example, 'exp_xxxxx' or 'feed_xxxxx'.
@@ -23693,7 +23334,7 @@ client.messages.list(
-
-**after:** `typing.Optional[str]` — Returns the elements in the list that come after the specified cursor.
+**content:** `str` — The body of the message in Markdown format. For example, 'Hello **world**'.
@@ -23701,7 +23342,7 @@ client.messages.list(
-
-**before:** `typing.Optional[str]` — Returns the elements in the list that come before the specified cursor.
+**attachments:** `typing.Optional[typing.List[CreateMessagesRequestAttachmentsItem]]` — A list of file attachments to include with the message, such as images or videos.
@@ -23709,7 +23350,7 @@ client.messages.list(
-
-**first:** `typing.Optional[int]` — Returns the first _n_ elements from the list.
+**auto_detect_links:** `typing.Optional[bool]` — Automatically detect URLs in the message and generate link previews.
@@ -23717,7 +23358,7 @@ client.messages.list(
-
-**last:** `typing.Optional[int]` — Returns the last _n_ elements from the list.
+**poll:** `typing.Optional[CreateMessagesRequestPoll]` — A poll to attach to this message, allowing recipients to vote on options.
@@ -23725,7 +23366,7 @@ client.messages.list(
-
-**direction:** `typing.Optional[Direction]`
+**replying_to_message_id:** `typing.Optional[str]` — The unique identifier of the message this is replying to, creating a threaded reply.
@@ -23745,7 +23386,7 @@ client.messages.list(
client.messages.create(...) -> Message
+client.messages.retrieve(...) -> Message
-
@@ -23757,13 +23398,13 @@ client.messages.list(
-
-Send a new message in an experience chat, DM, or group chat channel. Supports text content, attachments, polls, and replies.
+Retrieves the details of an existing message.
Required permissions (one of):
- - `chat:message:create`
- - `dms:message:manage`
- - `livestream:chat:write`
- - `support_chat:message:create`
+ - `chat:read`
+ - `dms:read`
+ - `livestream:chat:read`
+ - `support_chat:read`
@@ -23786,9 +23427,8 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.messages.create(
- channel_id="channel_id",
- content="content",
+client.messages.retrieve(
+ id="id",
)
```
@@ -23805,7 +23445,7 @@ client.messages.create(
-
-**channel_id:** `str` — The unique identifier of the channel or experience to send the message in. For example, 'exp_xxxxx' or 'feed_xxxxx'.
+**id:** `str` — The unique identifier of the message to retrieve.
@@ -23813,39 +23453,78 @@ client.messages.create(
-
-**content:** `str` — The body of the message in Markdown format. For example, 'Hello **world**'.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**attachments:** `typing.Optional[typing.List[CreateMessagesRequestAttachmentsItem]]` — A list of file attachments to include with the message, such as images or videos.
-
+client.messages.delete(...) -> bool
-
-**auto_detect_links:** `typing.Optional[bool]` — Automatically detect URLs in the message and generate link previews.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Permanently delete a message from an experience chat, DM, or group chat channel. Only the message author or a channel admin can delete a message.
+
+Required permissions (one of):
+ - `chat:message:create` and `chat:read`
+ - `dms:message:manage` and `dms:read`
+ - `livestream:chat:write` and `livestream:chat:read`
+ - `support_chat:message:create` and `support_chat:read`
+
+
+
+#### 🔌 Usage
-
-**poll:** `typing.Optional[CreateMessagesRequestPoll]` — A poll to attach to this message, allowing recipients to vote on options.
-
+
+-
+
+```python
+from whop_sdk import Whop
+from whop_sdk.environment import WhopEnvironment
+
+client = Whop(
+ token="",
+ environment=WhopEnvironment.DEFAULT,
+)
+
+client.messages.delete(
+ id="id",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**replying_to_message_id:** `typing.Optional[str]` — The unique identifier of the message this is replying to, creating a threaded reply.
+
+-
+
+**id:** `str` — The unique identifier of the message to delete.
@@ -23865,7 +23544,7 @@ client.messages.create(
client.messages.retrieve(...) -> Message
+client.messages.update(...) -> Message
-
@@ -23877,13 +23556,13 @@ client.messages.create(
-
-Retrieves the details of an existing message.
+Edit the content, attachments, or pinned status of an existing message in an experience chat, DM, or group chat channel.
Required permissions (one of):
- - `chat:read`
- - `dms:read`
- - `livestream:chat:read`
- - `support_chat:read`
+ - `chat:message:create`
+ - `dms:message:manage`
+ - `livestream:chat:write`
+ - `support_chat:message:create`
@@ -23906,7 +23585,7 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.messages.retrieve(
+client.messages.update(
id="id",
)
@@ -23924,7 +23603,7 @@ client.messages.retrieve(
-
-**id:** `str` — The unique identifier of the message to retrieve.
+**id:** `str` — The unique identifier of the message to update.
@@ -23932,78 +23611,23 @@ client.messages.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**attachments:** `typing.Optional[typing.List[UpdateMessagesRequestAttachmentsItem]]` — A replacement list of file attachments for this message, such as images or videos.
-
-
-
-
-
-client.messages.delete(...) -> bool
-
-#### 📝 Description
-
-
--
-
-
--
-
-Permanently delete a message from an experience chat, DM, or group chat channel. Only the message author or a channel admin can delete a message.
-
-Required permissions (one of):
- - `chat:message:create` and `chat:read`
- - `dms:message:manage` and `dms:read`
- - `livestream:chat:write` and `livestream:chat:read`
- - `support_chat:message:create` and `support_chat:read`
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from whop_sdk import Whop
-from whop_sdk.environment import WhopEnvironment
-
-client = Whop(
- token="",
- environment=WhopEnvironment.DEFAULT,
-)
-
-client.messages.delete(
- id="id",
-)
-
-```
-
-
+**content:** `typing.Optional[str]` — The updated body of the message in Markdown format. For example, 'Hello **world**'.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**id:** `str` — The unique identifier of the message to delete.
+**is_pinned:** `typing.Optional[bool]` — Whether this message should be pinned to the top of the channel.
@@ -24023,7 +23647,8 @@ client.messages.delete(
client.messages.update(...) -> Message
+## Notifications
+client.notifications.list(...) -> ListNotificationsResponse
-
@@ -24035,13 +23660,7 @@ client.messages.delete(
-
-Edit the content, attachments, or pinned status of an existing message in an experience chat, DM, or group chat channel.
-
-Required permissions (one of):
- - `chat:message:create`
- - `dms:message:manage`
- - `livestream:chat:write`
- - `support_chat:message:create`
+Lists the authenticated user's notifications, newest first. Requires a user credential — an account API key has no notification feed. Without filters the feed spans every experience the user belongs to plus the teams they are a member of.
@@ -24064,9 +23683,7 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.messages.update(
- id="id",
-)
+client.notifications.list()
```
@@ -24082,7 +23699,7 @@ client.messages.update(
-
-**id:** `str` — The unique identifier of the message to update.
+**unread:** `typing.Optional[bool]` — Only return notifications created since the user last viewed their source.
@@ -24090,7 +23707,7 @@ client.messages.update(
-
-**attachments:** `typing.Optional[typing.List[UpdateMessagesRequestAttachmentsItem]]` — A replacement list of file attachments for this message, such as images or videos.
+**experience_id:** `typing.Optional[str]` — Only return notifications from this experience (`exp_` tag).
@@ -24098,7 +23715,7 @@ client.messages.update(
-
-**content:** `typing.Optional[str]` — The updated body of the message in Markdown format. For example, 'Hello **world**'.
+**account_id:** `typing.Optional[str]` — Only return team notifications for this account (`biz_` tag).
@@ -24106,7 +23723,23 @@ client.messages.update(
-
-**is_pinned:** `typing.Optional[bool]` — Whether this message should be pinned to the top of the channel.
+**mentions:** `typing.Optional[bool]` — Only return notifications that mention the user directly.
+
+
+
+
+
+-
+
+**first:** `typing.Optional[int]` — The number of notifications to return (default 20, max 100).
+
+
+
+
+
+-
+
+**after:** `typing.Optional[str]` — A cursor (a notification `id` from a previous page); returns notifications older than it.
@@ -24126,8 +23759,7 @@ client.messages.update(
client.notifications.list(...) -> ListNotificationsResponse
+client.notifications.create(...) -> CreateNotificationsResponse
-
@@ -24139,7 +23771,7 @@ client.messages.update(
-
-Lists the authenticated user's notifications, newest first. Requires a user credential — an account API key has no notification feed. Without filters the feed spans every experience the user belongs to plus the teams they are a member of.
+Queues a notification to every user of an experience or to an account's team, processed asynchronously. Every send is attributed to an app: use an app API key, or a credential acting on behalf of an app. Narrow the audience with `user_ids` to send a mention.
@@ -24162,7 +23794,10 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.notifications.list()
+client.notifications.create(
+ content="Drop off at 4180 Burnet Rd. Plan on two days for the full coating.",
+ title="Your ceramic coating is booked",
+)
```
@@ -24178,7 +23813,7 @@ client.notifications.list()
-
-**unread:** `typing.Optional[bool]` — Only return notifications created since the user last viewed their source.
+**content:** `str` — Main body text of the notification.
@@ -24186,7 +23821,7 @@ client.notifications.list()
-
-**experience_id:** `typing.Optional[str]` — Only return notifications from this experience (`exp_` tag).
+**title:** `str` — Headline text of the notification.
@@ -24194,7 +23829,7 @@ client.notifications.list()
-
-**account_id:** `typing.Optional[str]` — Only return team notifications for this account (`biz_` tag).
+**account_id:** `typing.Optional[str]` — Account whose team members receive the notification (`biz_` tag). Exactly one of `experience_id` or `account_id` is required.
@@ -24202,7 +23837,7 @@ client.notifications.list()
-
-**mentions:** `typing.Optional[bool]` — Only return notifications that mention the user directly.
+**experience_id:** `typing.Optional[str]` — Experience whose users receive the notification (`exp_` tag). Exactly one of `experience_id` or `account_id` is required.
@@ -24210,7 +23845,7 @@ client.notifications.list()
-
-**first:** `typing.Optional[int]` — The number of notifications to return (default 20, max 100).
+**icon_user_id:** `typing.Optional[str]` — User whose profile picture is used as the notification icon. Defaults to the experience or account avatar.
@@ -24218,7 +23853,23 @@ client.notifications.list()
-
-**after:** `typing.Optional[str]` — A cursor (a notification `id` from a previous page); returns notifications older than it.
+**rest_path:** `typing.Optional[str]` — Path segment appended to the generated deep link that opens your app, for example `/settings/billing`.
+
+
+
+
+
+-
+
+**subtitle:** `typing.Optional[str]` — Optional secondary line displayed below the title.
+
+
+
+
+
+-
+
+**user_ids:** `typing.Optional[typing.List[str]]` — Optional `user_` tags narrowing the audience. When provided, only these users are notified (as a mention), provided they are in the targeted experience or account.
@@ -24238,7 +23889,7 @@ client.notifications.list()
client.notifications.create(...) -> CreateNotificationsResponse
+client.notifications.badges(...) -> BadgesNotificationsResponse
-
@@ -24250,7 +23901,7 @@ client.notifications.list()
-
-Queues a notification to every user of an experience or to an account's team, processed asynchronously. Every send is attributed to an app: use an app API key, or a credential acting on behalf of an app. Narrow the audience with `user_ids` to send a mention.
+Lists the authenticated user's per-experience unread badge state. Requires a user credential. Returns one row per experience the user belongs to (or per requested experience).
@@ -24273,9 +23924,10 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.notifications.create(
- content="Drop off at 4180 Burnet Rd. Plan on two days for the full coating.",
- title="Your ceramic coating is booked",
+client.notifications.badges(
+ experience_ids=[
+ "exp_xxxxxxxxxxxxxx"
+ ],
)
```
@@ -24292,7 +23944,7 @@ client.notifications.create(
-
-**content:** `str` — Main body text of the notification.
+**experience_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Only return badges for these experiences (`exp_` tags).
@@ -24300,7 +23952,7 @@ client.notifications.create(
-
-**title:** `str` — Headline text of the notification.
+**last_fetched_at:** `typing.Optional[str]` — The client's last fetched-at ISO 8601 timestamp, used to partially refresh badges after a websocket message.
@@ -24308,39 +23960,70 @@ client.notifications.create(
-
-**account_id:** `typing.Optional[str]` — Account whose team members receive the notification (`biz_` tag). Exactly one of `experience_id` or `account_id` is required.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**experience_id:** `typing.Optional[str]` — Experience whose users receive the notification (`exp_` tag). Exactly one of `experience_id` or `account_id` is required.
-
+client.notifications.mark_read(...) -> MarkReadNotificationsResponse
-
-**icon_user_id:** `typing.Optional[str]` — User whose profile picture is used as the notification icon. Defaults to the experience or account avatar.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Marks the authenticated user's notifications as read: one experience's (`experience_id`) or everything (`all: true`) — exactly one of the two. Requires a user credential. Responds with the refreshed badge rows for the affected scope.
+
+
+#### 🔌 Usage
+
-
-**rest_path:** `typing.Optional[str]` — Path segment appended to the generated deep link that opens your app, for example `/settings/billing`.
-
+
+-
+
+```python
+from whop_sdk import Whop
+from whop_sdk.environment import WhopEnvironment
+
+client = Whop(
+ token="",
+ environment=WhopEnvironment.DEFAULT,
+)
+
+client.notifications.mark_read()
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**subtitle:** `typing.Optional[str]` — Optional secondary line displayed below the title.
+
+-
+
+**all:** `typing.Optional[bool]` — Pass `true` to mark every notification read. Exactly one of `experience_id` or `all` is required.
@@ -24348,7 +24031,7 @@ client.notifications.create(
-
-**user_ids:** `typing.Optional[typing.List[str]]` — Optional `user_` tags narrowing the audience. When provided, only these users are notified (as a mention), provided they are in the targeted experience or account.
+**experience_id:** `typing.Optional[str]` — Experience to mark read (`exp_` tag). Exactly one of `experience_id` or `all` is required.
@@ -24368,7 +24051,7 @@ client.notifications.create(
client.notifications.badges(...) -> BadgesNotificationsResponse
+client.notifications.retrieve(...) -> Notification
-
@@ -24380,7 +24063,7 @@ client.notifications.create(
-
-Lists the authenticated user's per-experience unread badge state. Requires a user credential. Returns one row per experience the user belongs to (or per requested experience).
+Retrieves a single notification by id — either an `id` returned by List Notifications, or the ephemeral id delivered with a push/websocket event. Requires a user credential.
@@ -24403,10 +24086,8 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.notifications.badges(
- experience_ids=[
- "exp_xxxxxxxxxxxxxx"
- ],
+client.notifications.retrieve(
+ id="id",
)
```
@@ -24423,15 +24104,7 @@ client.notifications.badges(
-
-**experience_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Only return badges for these experiences (`exp_` tags).
-
-
-
-
-
--
-
-**last_fetched_at:** `typing.Optional[str]` — The client's last fetched-at ISO 8601 timestamp, used to partially refresh badges after a websocket message.
+**id:** `str` — A notification `id` from List Notifications, or the id delivered with a push/websocket event.
@@ -24451,7 +24124,8 @@ client.notifications.badges(
client.notifications.mark_read(...) -> MarkReadNotificationsResponse
+## Partners
+client.partners.create() -> CreatePartnersResponse
-
@@ -24463,7 +24137,7 @@ client.notifications.badges(
-
-Marks the authenticated user's notifications as read: one experience's (`experience_id`) or everything (`all: true`) — exactly one of the two. Requires a user credential. Responds with the refreshed badge rows for the affected scope.
+Enrolls the calling user in the Whop partner program, making their partner businesses eligible for earnings. Idempotent — enrolling again keeps the original enrollment time.
@@ -24486,7 +24160,7 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.notifications.mark_read()
+client.partners.create()
```
@@ -24502,22 +24176,6 @@ client.notifications.mark_read()
-
-**all:** `typing.Optional[bool]` — Pass `true` to mark every notification read. Exactly one of `experience_id` or `all` is required.
-
-
-
-
-
--
-
-**experience_id:** `typing.Optional[str]` — Experience to mark read (`exp_` tag). Exactly one of `experience_id` or `all` is required.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -24530,7 +24188,7 @@ client.notifications.mark_read()
client.notifications.retrieve(...) -> Notification
+client.partners.leaderboard(...) -> LeaderboardPartnersResponse
-
@@ -24542,7 +24200,7 @@ client.notifications.mark_read()
-
-Retrieves a single notification by id — either an `id` returned by List Notifications, or the ephemeral id delivered with a push/websocket event. Requires a user credential.
+Ranks referrers by partner business earnings — all-time by default, or over the current day, month, year, or trailing 30 days. Authentication is optional: authenticated callers also get their own standing, anonymous callers get the rankings alone.
@@ -24565,9 +24223,7 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.notifications.retrieve(
- id="id",
-)
+client.partners.leaderboard()
```
@@ -24583,7 +24239,7 @@ client.notifications.retrieve(
-
-**id:** `str` — A notification `id` from List Notifications, or the id delivered with a push/websocket event.
+**period:** `typing.Optional[LeaderboardPartnersRequestPeriod]` — Time window for the rankings. `day`, `month`, and `year` count earnings since the start of the current calendar day, month, or year; `last_30_days` counts earnings over the trailing 30 days; `all_time` ranks lifetime earnings.
@@ -24603,8 +24259,7 @@ client.notifications.retrieve(
client.partners.create() -> CreatePartnersResponse
+client.partners.retrieve_link(...) -> OnboardingReward
-
@@ -24616,7 +24271,7 @@ client.notifications.retrieve(
-
-Enrolls the calling user in the Whop partner program, making their partner businesses eligible for earnings. Idempotent — enrolling again keeps the original enrollment time.
+Resolves the public reward terms and whether redemption capacity remains. Immediate rewards claim capacity at business creation; qualified rewards claim it when the business reaches the threshold.
@@ -24639,7 +24294,10 @@ client = Whop(
environment=WhopEnvironment.DEFAULT,
)
-client.partners.create()
+client.partners.retrieve_link(
+ partner_username="partner_username",
+ reward_slug="reward_slug",
+)
```
@@ -24655,70 +24313,15 @@ client.partners.create()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**partner_username:** `str` — Username from the partner link's `a` query parameter.
-
-
-
-
-
-
-client.partners.leaderboard(...) -> LeaderboardPartnersResponse
-
--
-
-#### 📝 Description
-
-
--
-
-Ranks referrers by partner business earnings — all-time by default, or over the current day, month, year, or trailing 30 days. Authentication is optional: authenticated callers also get their own standing, anonymous callers get the rankings alone.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from whop_sdk import Whop
-from whop_sdk.environment import WhopEnvironment
-
-client = Whop(
- token="",
- environment=WhopEnvironment.DEFAULT,
-)
-
-client.partners.leaderboard()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**period:** `typing.Optional[LeaderboardPartnersRequestPeriod]` — Time window for the rankings. `day`, `month`, and `year` count earnings since the start of the current calendar day, month, or year; `last_30_days` counts earnings over the trailing 30 days; `all_time` ranks lifetime earnings.
+**reward_slug:** `str` — Reward slug from the partner link's `reward` query parameter.
@@ -25070,7 +24673,7 @@ client.payment_method_domains.create(
-
-**account_id:** `typing.Optional[str]` — Account to register the domain for (`biz_` tag). Defaults to the caller's account.
+**account_id:** `typing.Optional[str]` — Account to register the domain for (`biz_` tag). Required when authenticating as a user; an account API key supplies its own account.
@@ -26496,6 +26099,79 @@ client.payments.void(
+
+
+client.payments.resume(...) -> PaymentStatus
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Starts a fresh on-session attempt with the saved card for a subscription renewal that is waiting on the customer to authenticate; the bank's step then arrives in `next_action` on the following status reads. Only the payment's own customer may call it — with the payment's `client_secret` or their own session — and it is a no-op for any payment that is not a parked renewal.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from whop_sdk import Whop
+from whop_sdk.environment import WhopEnvironment
+
+client = Whop(
+ token="",
+ environment=WhopEnvironment.DEFAULT,
+)
+
+client.payments.resume(
+ payment_id="payment_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**payment_id:** `str` — The unique identifier of the payment.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
-
-**account_id:** `typing.Optional[str]` — The unique identifier of the account to create this plan for. Defaults to the caller's account.
+**account_id:** `typing.Optional[str]` — The unique identifier of the account to create this plan for. Required when authenticating as a user; an account API key supplies its own account.
@@ -28295,7 +27971,7 @@ client.plans.create()
-
-**initial_price:** `typing.Optional[float]` — Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.
+**initial_price:** `typing.Optional[float]` — Initial amount charged in the plan's currency, e.g. 10.43 for $10.43. A paid fiat plan charges at least 1.00 in its currency; use 0 for free.
@@ -28359,7 +28035,7 @@ client.plans.create()
-
-**renewal_price:** `typing.Optional[float]` — The amount charged each billing period for recurring plans, in the plan's currency.
+**renewal_price:** `typing.Optional[float]` — The amount charged each billing period for recurring plans, in the plan's currency. A paid fiat plan charges at least 1.00 in its currency.
@@ -28722,7 +28398,7 @@ client.plans.update(
-
-**initial_price:** `typing.Optional[float]` — Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.
+**initial_price:** `typing.Optional[float]` — Initial amount charged in the plan's currency, e.g. 10.43 for $10.43. A paid fiat plan charges at least 1.00 in its currency; use 0 for free.
@@ -28778,7 +28454,7 @@ client.plans.update(
-
-**renewal_price:** `typing.Optional[float]` — The amount charged each billing period for recurring plans, in the plan's currency.
+**renewal_price:** `typing.Optional[float]` — The amount charged each billing period for recurring plans, in the plan's currency. A paid fiat plan charges at least 1.00 in its currency.
@@ -29691,7 +29367,7 @@ client.products.update(
-
-Submits a product to the whop.com marketplace for review. The product moves to `pending_review`; a Whop reviewer approves it before it goes live.
+Submits a product to the whop.com marketplace for review. The product moves to `pending_review`; a Whop reviewer approves it before it goes live. Requires a logo, a headline, and at least one gallery image or video; the request fails naming whichever is missing.
@@ -36549,6 +36225,22 @@ client.transfers.create(
-
+**feed_id:** `typing.Optional[str]` — Ledger transfers only. The feed the transfer was initiated from. Given with `feed_type`, the payment receipt posts into that feed instead of a direct message.
+
+
+
+
+
+-
+
+**feed_type:** `typing.Optional[CreateTransfersRequestFeedType]` — Ledger transfers only. The type of the feed named by `feed_id`.
+
+
+
+
+
+-
+
**idempotence_key:** `typing.Optional[str]` — Ledger transfers and wallet sends. A unique key that makes retries safe. Retrying with the same key returns the original transfer, or attaches to the original wallet send, instead of moving money twice.
@@ -38696,116 +38388,6 @@ client.webhooks.test(
-
-
-client.webhooks.deliveries_webhook(...) -> DeliveriesWebhookResponse
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a paginated list of delivery attempts for a webhook, ordered by most recent first. Includes the request payload, response body, response code, and timing for each attempt.
-
-Required permissions:
- - `developer:manage_webhook`
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from whop_sdk import Whop
-from whop_sdk.environment import WhopEnvironment
-
-client = Whop(
- token="",
- environment=WhopEnvironment.DEFAULT,
-)
-
-client.webhooks.deliveries_webhook(
- webhook_id="webhook_id",
- first=42,
- last=42,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**webhook_id:** `str` — The unique identifier of the webhook to list deliveries for.
-
-
-
-
-
--
-
-**after:** `typing.Optional[str]` — Returns the elements in the list that come after the specified cursor.
-
-
-
-
-
--
-
-**before:** `typing.Optional[str]` — Returns the elements in the list that come before the specified cursor.
-
-
-
-
-
--
-
-**first:** `typing.Optional[int]` — Returns the first _n_ elements from the list.
-
-
-
-
-
--
-
-**last:** `typing.Optional[int]` — Returns the last _n_ elements from the list.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-