api.md

Shared Types

from whop_sdk.types import (
    AccessLevel,
    AccessPassType,
    App,
    AppBuild,
    AppBuildPlatforms,
    AppBuildStatuses,
    AppStatuses,
    AppViewType,
    AuthorizedUserRoles,
    ChatChannel,
    CheckoutConfiguration,
    CollectionMethod,
    Company,
    CourseLessonInteraction,
    CourseLessonInteractionListItem,
    Currency,
    CustomCta,
    Direction,
    DmsPostTypes,
    EmailNotificationPreferences,
    Entry,
    EntryStatus,
    Experience,
    Forum,
    ForumPost,
    FriendlyReceiptStatus,
    GlobalAffiliateStatus,
    Invoice,
    InvoiceListItem,
    InvoiceStatus,
    MemberMostRecentActions,
    MemberStatuses,
    Membership,
    MembershipStatus,
    Message,
    PageInfo,
    Payment,
    Plan,
    PlanType,
    Product,
    ProductListItem,
    PromoType,
    Reaction,
    ReceiptStatus,
    ReleaseMethod,
    Shipment,
    ShipmentCarrier,
    ShipmentStatus,
    ShipmentSubstatus,
    SupportChannel,
    TaxType,
    Visibility,
    VisibilityFilter,
    WhoCanCommentTypes,
    WhoCanPost,
    WhoCanPostTypes,
    WhoCanReact,
)

Apps

Types:

from whop_sdk.types import AppType, AppListResponse, AppLogsResponse

Methods:

• client.apps.create(**params) -> App
• client.apps.retrieve(id) -> App
• client.apps.update(id, **params) -> App
• client.apps.list(**params) -> SyncCursorPage[AppListResponse]
• client.apps.logs(id, **params) -> AppLogsResponse

Invoices

Types:

from whop_sdk.types import (
    TaxIdentifierType,
    InvoiceDeleteResponse,
    InvoiceMarkPaidResponse,
    InvoiceMarkUncollectibleResponse,
    InvoiceVoidResponse,
)

Methods:

• client.invoices.create(**params) -> Invoice
• client.invoices.retrieve(id) -> Invoice
• client.invoices.update(id, **params) -> Invoice
• client.invoices.list(**params) -> SyncCursorPage[InvoiceListItem]
• client.invoices.delete(id) -> InvoiceDeleteResponse
• client.invoices.mark_paid(id) -> InvoiceMarkPaidResponse
• client.invoices.mark_uncollectible(id) -> InvoiceMarkUncollectibleResponse
• client.invoices.void(id) -> InvoiceVoidResponse

CourseLessonInteractions

Methods:

• client.course_lesson_interactions.retrieve(id) -> CourseLessonInteraction
• client.course_lesson_interactions.list(**params) -> SyncCursorPage[CourseLessonInteractionListItem]

Products

Types:

from whop_sdk.types import ProductDeleteResponse

Methods:

• client.products.create(**params) -> Product
• client.products.retrieve(id) -> Product
• client.products.update(id, **params) -> Product
• client.products.list(**params) -> SyncCursorPage[ProductListItem]
• client.products.delete(id) -> ProductDeleteResponse

SocialAccounts

Types:

from whop_sdk.types import (
    SocialAccount,
    SocialAccountPost,
    SocialAccountDeleteResponse,
    SocialAccountConnectResponse,
    SocialAccountPostsResponse,
)

Methods:

• client.social_accounts.create(**params) -> SocialAccount
• client.social_accounts.list(**params) -> SyncCursorPage[SocialAccount]
• client.social_accounts.delete(id, **params) -> SocialAccountDeleteResponse
• client.social_accounts.connect(**params) -> SocialAccountConnectResponse
• client.social_accounts.posts(id, **params) -> SocialAccountPostsResponse

Audiences

Types:

from whop_sdk.types import Audience, AudienceDeleteResponse

Methods:

• client.audiences.create(**params) -> Audience
• client.audiences.list(**params) -> SyncCursorPage[Audience]
• client.audiences.delete(audience_id) -> AudienceDeleteResponse

Media

Types:

from whop_sdk.types import MediaAsset

Methods:

• client.media.retrieve(id) -> MediaAsset
• client.media.generate(**params) -> MediaAsset

People

Types:

from whop_sdk.types import PersonRetrieveResponse, PersonListResponse

Methods:

• client.people.retrieve(person_id, **params) -> PersonRetrieveResponse
• client.people.list(**params) -> SyncCursorPage[PersonListResponse]

Events

Types:

from whop_sdk.types import EventCreateResponse, EventListResponse

Methods:

• client.events.create(**params) -> EventCreateResponse
• client.events.list(**params) -> SyncCursorPage[EventListResponse]

Companies

Types:

from whop_sdk.types import SocialLinkWebsites, CompanyListResponse, CompanyCreateAPIKeyResponse

Methods:

• client.companies.create(**params) -> Company
• client.companies.retrieve(id) -> Company
• client.companies.update(id, **params) -> Company
• client.companies.list(**params) -> SyncCursorPage[CompanyListResponse]
• client.companies.create_api_key(parent_company_id, **params) -> CompanyCreateAPIKeyResponse

Webhooks

Types:

from whop_sdk.types import (
    APIVersion,
    Webhook,
    WebhookEvent,
    WebhookCreateResponse,
    WebhookListResponse,
    WebhookDeleteResponse,
    ChatMessageCreatedWebhookEvent,
    ChatReactionCreatedWebhookEvent,
    CourseLessonInteractionCompletedWebhookEvent,
    DisputeCreatedWebhookEvent,
    DisputeUpdatedWebhookEvent,
    DisputeAlertCreatedWebhookEvent,
    EntryApprovedWebhookEvent,
    EntryCreatedWebhookEvent,
    EntryDeletedWebhookEvent,
    EntryDeniedWebhookEvent,
    IdentityProfileApprovedWebhookEvent,
    IdentityProfileNeedsActionWebhookEvent,
    IdentityProfileRejectedWebhookEvent,
    IdentityProfileUpdatedWebhookEvent,
    InvoiceCreatedWebhookEvent,
    InvoiceMarkedUncollectibleWebhookEvent,
    InvoicePaidWebhookEvent,
    InvoicePastDueWebhookEvent,
    InvoiceVoidedWebhookEvent,
    LedgerAccountFundsAvailableWebhookEvent,
    MembershipActivatedWebhookEvent,
    MembershipCancelAtPeriodEndChangedWebhookEvent,
    MembershipDeactivatedWebhookEvent,
    MembershipTrialEndingSoonWebhookEvent,
    PaymentCreatedWebhookEvent,
    PaymentFailedWebhookEvent,
    PaymentPendingWebhookEvent,
    PaymentSucceededWebhookEvent,
    PayoutAccountStatusUpdatedWebhookEvent,
    PayoutMethodCreatedWebhookEvent,
    RefundCreatedWebhookEvent,
    RefundUpdatedWebhookEvent,
    ResolutionCenterCaseCreatedWebhookEvent,
    ResolutionCenterCaseDecidedWebhookEvent,
    ResolutionCenterCaseUpdatedWebhookEvent,
    SetupIntentCanceledWebhookEvent,
    SetupIntentRequiresActionWebhookEvent,
    SetupIntentSucceededWebhookEvent,
    VerificationSucceededWebhookEvent,
    WithdrawalCreatedWebhookEvent,
    WithdrawalUpdatedWebhookEvent,
    UnwrapWebhookEvent,
)

Methods:

• client.webhooks.create(**params) -> WebhookCreateResponse
• client.webhooks.retrieve(id) -> Webhook
• client.webhooks.update(id, **params) -> Webhook
• client.webhooks.list(**params) -> SyncCursorPage[WebhookListResponse]
• client.webhooks.delete(id) -> WebhookDeleteResponse

Plans

Types:

from whop_sdk.types import (
    CheckoutFont,
    CheckoutShape,
    PlanListResponse,
    PlanDeleteResponse,
    PlanCalculateTaxResponse,
)

Methods:

• client.plans.create(**params) -> Plan
• client.plans.retrieve(id) -> Plan
• client.plans.update(id, **params) -> Plan
• client.plans.list(**params) -> SyncCursorPage[PlanListResponse]
• client.plans.delete(id) -> PlanDeleteResponse
• client.plans.calculate_tax(id, **params) -> PlanCalculateTaxResponse

Entries

Types:

from whop_sdk.types import EntryListResponse, EntryApproveResponse

Methods:

• client.entries.retrieve(id) -> Entry
• client.entries.list(**params) -> SyncCursorPage[EntryListResponse]
• client.entries.approve(id) -> EntryApproveResponse
• client.entries.deny(id) -> Entry

ForumPosts

Types:

from whop_sdk.types import ForumPostVisibilityType, ForumPostListResponse

Methods:

• client.forum_posts.create(**params) -> ForumPost
• client.forum_posts.retrieve(id) -> ForumPost
• client.forum_posts.update(id, **params) -> ForumPost
• client.forum_posts.list(**params) -> SyncCursorPage[ForumPostListResponse]

Transfers

Types:

from whop_sdk.types import TransferCreateResponse, TransferRetrieveResponse, TransferListResponse

Methods:

• client.transfers.create(**params) -> TransferCreateResponse
• client.transfers.retrieve(id) -> TransferRetrieveResponse
• client.transfers.list(**params) -> SyncCursorPage[TransferListResponse]

LedgerAccounts

Types:

from whop_sdk.types import LedgerAccountRetrieveResponse

Methods:

• client.ledger_accounts.retrieve(id) -> LedgerAccountRetrieveResponse

Memberships

Types:

from whop_sdk.types import CancelOptions, MembershipListResponse

Methods:

• client.memberships.retrieve(id) -> Membership
• client.memberships.update(id, **params) -> Membership
• client.memberships.list(**params) -> SyncCursorPage[MembershipListResponse]
• client.memberships.add_free_days(id, **params) -> Membership
• client.memberships.cancel(id, **params) -> Membership
• client.memberships.pause(id, **params) -> Membership
• client.memberships.resume(id) -> Membership
• client.memberships.uncancel(id) -> Membership

AuthorizedUsers

Types:

from whop_sdk.types import AuthorizedUser, AuthorizedUserListResponse, AuthorizedUserDeleteResponse

Methods:

• client.authorized_users.create(**params) -> AuthorizedUser
• client.authorized_users.retrieve(id) -> AuthorizedUser
• client.authorized_users.list(**params) -> SyncCursorPage[AuthorizedUserListResponse]
• client.authorized_users.delete(id, **params) -> AuthorizedUserDeleteResponse

AppBuilds

Types:

from whop_sdk.types import AppBuildListResponse

Methods:

• client.app_builds.create(**params) -> AppBuild
• client.app_builds.retrieve(id) -> AppBuild
• client.app_builds.list(**params) -> SyncCursorPage[AppBuildListResponse]
• client.app_builds.promote(id) -> AppBuild

Shipments

Types:

from whop_sdk.types import ShipmentListResponse

Methods:

• client.shipments.create(**params) -> Shipment
• client.shipments.retrieve(id) -> Shipment
• client.shipments.list(**params) -> SyncCursorPage[ShipmentListResponse]

CheckoutConfigurations

Types:

from whop_sdk.types import (
    CheckoutModes,
    CheckoutConfigurationCreateResponse,
    CheckoutConfigurationRetrieveResponse,
    CheckoutConfigurationListResponse,
)

Methods:

• client.checkout_configurations.create(**params) -> CheckoutConfigurationCreateResponse
• client.checkout_configurations.retrieve(id) -> CheckoutConfigurationRetrieveResponse
• client.checkout_configurations.list(**params) -> SyncCursorPage[CheckoutConfigurationListResponse]
• client.checkout_configurations.delete(id) -> None

Messages

Types:

from whop_sdk.types import MessageListResponse, MessageDeleteResponse

Methods:

• client.messages.create(**params) -> Message
• client.messages.retrieve(id) -> Message
• client.messages.update(id, **params) -> Message
• client.messages.list(**params) -> SyncCursorPage[MessageListResponse]
• client.messages.delete(id) -> MessageDeleteResponse

ChatChannels

Types:

from whop_sdk.types import ChatChannelListResponse

Methods:

• client.chat_channels.retrieve(id) -> ChatChannel
• client.chat_channels.update(id, **params) -> ChatChannel
• client.chat_channels.list(**params) -> SyncCursorPage[ChatChannelListResponse]

Users

Types:

from whop_sdk.types import User, UserBalance, UserCheckAccessResponse

Methods:

• client.users.retrieve(id, **params) -> User
• client.users.update(id, **params) -> User
• client.users.list(**params) -> SyncCursorPage[User]
• client.users.check_access(resource_id, *, id) -> UserCheckAccessResponse
• client.users.update_me(**params) -> User

Payments

Types:

from whop_sdk.types import (
    BillingReasons,
    CardBrands,
    PaymentMethodTypes,
    ReceiptTaxBehavior,
    PaymentListResponse,
    PaymentListFeesResponse,
)

Methods:

• client.payments.create(**params) -> Payment
• client.payments.retrieve(id) -> Payment
• client.payments.list(**params) -> SyncCursorPage[PaymentListResponse]
• client.payments.list_fees(id, **params) -> SyncCursorPage[PaymentListFeesResponse]
• client.payments.refund(id, **params) -> Payment
• client.payments.retry(id) -> Payment
• client.payments.void(id) -> Payment

SupportChannels

Types:

from whop_sdk.types import SupportChannelListResponse

Methods:

• client.support_channels.create(**params) -> SupportChannel
• client.support_channels.retrieve(id) -> SupportChannel
• client.support_channels.list(**params) -> SyncCursorPage[SupportChannelListResponse]

Experiences

Types:

from whop_sdk.types import ExperienceListResponse, ExperienceDeleteResponse

Methods:

• client.experiences.create(**params) -> Experience
• client.experiences.retrieve(id) -> Experience
• client.experiences.update(id, **params) -> Experience
• client.experiences.list(**params) -> SyncCursorPage[ExperienceListResponse]
• client.experiences.delete(id) -> ExperienceDeleteResponse
• client.experiences.attach(id, **params) -> Experience
• client.experiences.detach(id, **params) -> Experience
• client.experiences.duplicate(id, **params) -> Experience

Reactions

Types:

from whop_sdk.types import ReactionListResponse, ReactionDeleteResponse

Methods:

• client.reactions.create(**params) -> Reaction
• client.reactions.retrieve(id) -> Reaction
• client.reactions.list(**params) -> SyncCursorPage[ReactionListResponse]
• client.reactions.delete(id, **params) -> ReactionDeleteResponse

Members

Types:

from whop_sdk.types import MemberRetrieveResponse, MemberListResponse

Methods:

• client.members.retrieve(id) -> MemberRetrieveResponse
• client.members.list(**params) -> SyncCursorPage[MemberListResponse]

Forums

Types:

from whop_sdk.types import ForumListResponse

Methods:

• client.forums.retrieve(id) -> Forum
• client.forums.update(id, **params) -> Forum
• client.forums.list(**params) -> SyncCursorPage[ForumListResponse]

PromoCodes

Types:

from whop_sdk.types import (
    PromoCode,
    PromoCodeStatus,
    PromoDuration,
    PromoCodeListResponse,
    PromoCodeDeleteResponse,
)

Methods:

• client.promo_codes.create(**params) -> PromoCode
• client.promo_codes.retrieve(id) -> PromoCode
• client.promo_codes.list(**params) -> SyncCursorPage[PromoCodeListResponse]
• client.promo_codes.delete(id) -> PromoCodeDeleteResponse

Courses

Types:

from whop_sdk.types import (
    Course,
    CourseVisibilities,
    Languages,
    CourseListResponse,
    CourseDeleteResponse,
)

Methods:

• client.courses.create(**params) -> Course
• client.courses.retrieve(id) -> Course
• client.courses.update(id, **params) -> Course
• client.courses.list(**params) -> SyncCursorPage[CourseListResponse]
• client.courses.delete(id) -> CourseDeleteResponse

CourseChapters

Types:

from whop_sdk.types import CourseChapter, CourseChapterListResponse, CourseChapterDeleteResponse

Methods:

• client.course_chapters.create(**params) -> CourseChapter
• client.course_chapters.retrieve(id) -> CourseChapter
• client.course_chapters.update(id, **params) -> CourseChapter
• client.course_chapters.list(**params) -> SyncCursorPage[CourseChapterListResponse]
• client.course_chapters.delete(id) -> CourseChapterDeleteResponse

CourseLessons

Types:

from whop_sdk.types import (
    AssessmentQuestionTypes,
    EmbedType,
    Lesson,
    LessonTypes,
    LessonVisibilities,
    CourseLessonListResponse,
    CourseLessonDeleteResponse,
    CourseLessonMarkAsCompletedResponse,
    CourseLessonStartResponse,
    CourseLessonSubmitAssessmentResponse,
)

Methods:

• client.course_lessons.create(**params) -> Lesson
• client.course_lessons.retrieve(id) -> Lesson
• client.course_lessons.update(id, **params) -> Lesson
• client.course_lessons.list(**params) -> SyncCursorPage[CourseLessonListResponse]
• client.course_lessons.delete(id) -> CourseLessonDeleteResponse
• client.course_lessons.mark_as_completed(lesson_id) -> CourseLessonMarkAsCompletedResponse
• client.course_lessons.start(lesson_id) -> CourseLessonStartResponse
• client.course_lessons.submit_assessment(lesson_id, **params) -> CourseLessonSubmitAssessmentResponse

Reviews

Types:

from whop_sdk.types import ReviewStatus, ReviewRetrieveResponse, ReviewListResponse

Methods:

• client.reviews.retrieve(id) -> ReviewRetrieveResponse
• client.reviews.list(**params) -> SyncCursorPage[ReviewListResponse]

CourseStudents

Types:

from whop_sdk.types import CourseStudentRetrieveResponse, CourseStudentListResponse

Methods:

• client.course_students.retrieve(id) -> CourseStudentRetrieveResponse
• client.course_students.list(**params) -> SyncCursorPage[CourseStudentListResponse]

AccessTokens

Types:

from whop_sdk.types import AccessTokenCreateResponse

Methods:

• client.access_tokens.create(**params) -> AccessTokenCreateResponse

Notifications

Types:

from whop_sdk.types import NotificationCreateResponse

Methods:

• client.notifications.create(**params) -> NotificationCreateResponse

Disputes

Types:

from whop_sdk.types import Dispute, DisputeStatuses, DisputeListResponse

Methods:

• client.disputes.retrieve(id) -> Dispute
• client.disputes.list(**params) -> SyncCursorPage[DisputeListResponse]
• client.disputes.submit_evidence(id) -> Dispute
• client.disputes.update_evidence(id, **params) -> Dispute

Refunds

Types:

from whop_sdk.types import (
    PaymentProvider,
    RefundReferenceStatus,
    RefundReferenceType,
    RefundStatus,
    RefundRetrieveResponse,
    RefundListResponse,
)

Methods:

• client.refunds.retrieve(id) -> RefundRetrieveResponse
• client.refunds.list(**params) -> SyncCursorPage[RefundListResponse]

Withdrawals

Types:

from whop_sdk.types import (
    Withdrawal,
    WithdrawalFeeTypes,
    WithdrawalSpeeds,
    WithdrawalStatus,
    WithdrawalListResponse,
)

Methods:

• client.withdrawals.create(**params) -> Withdrawal
• client.withdrawals.retrieve(id) -> Withdrawal
• client.withdrawals.list(**params) -> SyncCursorPage[WithdrawalListResponse]

AccountLinks

Types:

from whop_sdk.types import AccountLinkCreateResponse

Methods:

• client.account_links.create(**params) -> AccountLinkCreateResponse

Accounts

Types:

from whop_sdk.types import Account, AccountSocialLink, AccountRecommendActionsResponse

Methods:

• client.accounts.create(**params) -> Account
• client.accounts.retrieve(account_id) -> Account
• client.accounts.update(account_id, **params) -> Account
• client.accounts.list(**params) -> SyncCursorPage[Account]
• client.accounts.me() -> Account
• client.accounts.recommend_actions(account_id) -> AccountRecommendActionsResponse

Preferences

Types:

from whop_sdk.types.accounts import PreferenceRetrieveResponse, PreferenceUpdateResponse

Methods:

• client.accounts.preferences.retrieve(account_id) -> PreferenceRetrieveResponse
• client.accounts.preferences.update(account_id, **params) -> PreferenceUpdateResponse

FinancialActivity

Types:

from whop_sdk.types import FinancialActivityListResponse

Methods:

• client.financial_activity.list(**params) -> FinancialActivityListResponse

Stats

Types:

from whop_sdk.types import StatRetrieveResponse, StatListResponse

Methods:

• client.stats.retrieve(metric, **params) -> StatRetrieveResponse
• client.stats.list() -> StatListResponse

Payouts

Types:

from whop_sdk.types import PayoutCreateResponse, PayoutListResponse

Methods:

• client.payouts.create(**params) -> PayoutCreateResponse
• client.payouts.list(**params) -> SyncCursorPage[PayoutListResponse]

Methods

Types:

from whop_sdk.types.payouts import MethodListResponse

Methods:

• client.payouts.methods.list(**params) -> SyncCursorPage[MethodListResponse]

Referrals

Types:

from whop_sdk.types import ReferralReferredUsersResponse

Methods:

• client.referrals.referred_users(**params) -> ReferralReferredUsersResponse

Businesses

Types:

from whop_sdk.types.referrals import (
    BusinessRetrieveResponse,
    BusinessListResponse,
    BusinessLeaderboardResponse,
)

Methods:

• client.referrals.businesses.retrieve(id) -> BusinessRetrieveResponse
• client.referrals.businesses.list(**params) -> SyncCursorPage[BusinessListResponse]
• client.referrals.businesses.leaderboard(**params) -> BusinessLeaderboardResponse

Earnings

Types:

from whop_sdk.types.referrals.businesses import EarningListResponse

Methods:

• client.referrals.businesses.earnings.list(id, **params) -> SyncCursorPage[EarningListResponse]

Partners

Types:

from whop_sdk.types.referrals import PartnerCreateResponse

Methods:

• client.referrals.partners.create() -> PartnerCreateResponse

Cards

Types:

from whop_sdk.types import (
    CardCreateResponse,
    CardRetrieveResponse,
    CardUpdateResponse,
    CardListResponse,
)

Methods:

• client.cards.create(**params) -> CardCreateResponse
• client.cards.retrieve(card_id, **params) -> CardRetrieveResponse
• client.cards.update(card_id, **params) -> CardUpdateResponse
• client.cards.list(**params) -> CardListResponse

Swaps

Types:

from whop_sdk.types import (
    SwapCreateResponse,
    SwapRetrieveResponse,
    SwapListResponse,
    SwapCreateQuoteResponse,
)

Methods:

• client.swaps.create(**params) -> SwapCreateResponse
• client.swaps.retrieve(id) -> SwapRetrieveResponse
• client.swaps.list(**params) -> SwapListResponse
• client.swaps.create_quote(**params) -> SwapCreateQuoteResponse

Deposits

Types:

from whop_sdk.types import DepositCreateResponse, DepositListResponse

Methods:

• client.deposits.create(**params) -> DepositCreateResponse
• client.deposits.list(**params) -> DepositListResponse

SetupIntents

Types:

from whop_sdk.types import SetupIntent, SetupIntentStatus, SetupIntentListResponse

Methods:

• client.setup_intents.retrieve(id) -> SetupIntent
• client.setup_intents.list(**params) -> SyncCursorPage[SetupIntentListResponse]

PaymentMethods

Types:

from whop_sdk.types import PaymentMethodRetrieveResponse, PaymentMethodListResponse

Methods:

• client.payment_methods.retrieve(id, **params) -> PaymentMethodRetrieveResponse
• client.payment_methods.list(**params) -> SyncCursorPage[PaymentMethodListResponse]

FeeMarkups

Types:

from whop_sdk.types import (
    FeeMarkupType,
    FeeMarkupCreateResponse,
    FeeMarkupListResponse,
    FeeMarkupDeleteResponse,
)

Methods:

• client.fee_markups.create(**params) -> FeeMarkupCreateResponse
• client.fee_markups.list(**params) -> SyncCursorPage[FeeMarkupListResponse]
• client.fee_markups.delete(id) -> FeeMarkupDeleteResponse

Verifications

Types:

from whop_sdk.types import (
    VerificationErrorCode,
    VerificationStatus,
    VerificationCreateResponse,
    VerificationRetrieveResponse,
    VerificationUpdateResponse,
    VerificationListResponse,
)

Methods:

• client.verifications.create(**params) -> VerificationCreateResponse
• client.verifications.retrieve(verification_id) -> VerificationRetrieveResponse
• client.verifications.update(verification_id, **params) -> VerificationUpdateResponse
• client.verifications.list(**params) -> VerificationListResponse

Leads

Types:

from whop_sdk.types import Lead, LeadListResponse

Methods:

• client.leads.create(**params) -> Lead
• client.leads.retrieve(id) -> Lead
• client.leads.update(id, **params) -> Lead
• client.leads.list(**params) -> SyncCursorPage[LeadListResponse]

Topups

Types:

from whop_sdk.types import TopupCreateResponse

Methods:

• client.topups.create(**params) -> TopupCreateResponse

Files

Types:

from whop_sdk.types import FileVisibility, UploadStatus, FileCreateResponse, FileRetrieveResponse

Methods:

• client.files.create(**params) -> FileCreateResponse
• client.files.retrieve(id) -> FileRetrieveResponse

CompanyTokenTransactions

Types:

from whop_sdk.types import (
    CompanyTokenTransaction,
    CompanyTokenTransactionType,
    CompanyTokenTransactionListResponse,
)

Methods:

• client.company_token_transactions.create(**params) -> CompanyTokenTransaction
• client.company_token_transactions.retrieve(id) -> CompanyTokenTransaction
• client.company_token_transactions.list(**params) -> SyncCursorPage[CompanyTokenTransactionListResponse]

DmMembers

Types:

from whop_sdk.types import (
    DmFeedMemberNotificationPreferences,
    DmFeedMemberStatuses,
    DmMember,
    DmMemberListResponse,
    DmMemberDeleteResponse,
)

Methods:

• client.dm_members.create(**params) -> DmMember
• client.dm_members.retrieve(id) -> DmMember
• client.dm_members.update(id, **params) -> DmMember
• client.dm_members.list(**params) -> SyncCursorPage[DmMemberListResponse]
• client.dm_members.delete(id) -> DmMemberDeleteResponse

AIChats

Types:

from whop_sdk.types import AIChat, NotificationPreferences, AIChatListResponse, AIChatDeleteResponse

Methods:

• client.ai_chats.create(**params) -> AIChat
• client.ai_chats.retrieve(id) -> AIChat
• client.ai_chats.update(id, **params) -> AIChat
• client.ai_chats.list(**params) -> SyncCursorPage[AIChatListResponse]
• client.ai_chats.delete(id) -> AIChatDeleteResponse

DmChannels

Types:

from whop_sdk.types import DmChannel, DmChannelListResponse, DmChannelDeleteResponse

Methods:

• client.dm_channels.create(**params) -> DmChannel
• client.dm_channels.retrieve(id) -> DmChannel
• client.dm_channels.update(id, **params) -> DmChannel
• client.dm_channels.list(**params) -> SyncCursorPage[DmChannelListResponse]
• client.dm_channels.delete(id) -> DmChannelDeleteResponse

DisputeAlerts

Types:

from whop_sdk.types import DisputeAlertType, DisputeAlertRetrieveResponse, DisputeAlertListResponse

Methods:

• client.dispute_alerts.retrieve(id) -> DisputeAlertRetrieveResponse
• client.dispute_alerts.list(**params) -> SyncCursorPage[DisputeAlertListResponse]

ResolutionCenterCases

Types:

from whop_sdk.types import (
    ResolutionCenterCaseCustomerResponse,
    ResolutionCenterCaseIssueType,
    ResolutionCenterCaseMerchantResponse,
    ResolutionCenterCasePlatformResponse,
    ResolutionCenterCaseStatus,
    ResolutionCenterCaseRetrieveResponse,
    ResolutionCenterCaseListResponse,
)

Methods:

• client.resolution_center_cases.retrieve(id) -> ResolutionCenterCaseRetrieveResponse
• client.resolution_center_cases.list(**params) -> SyncCursorPage[ResolutionCenterCaseListResponse]

PayoutAccounts

Types:

from whop_sdk.types import PayoutAccountCalculatedStatuses, PayoutAccountRetrieveResponse

Methods:

• client.payout_accounts.retrieve(id) -> PayoutAccountRetrieveResponse

Affiliates

Types:

from whop_sdk.types import (
    Affiliate,
    Status,
    AffiliateListResponse,
    AffiliateArchiveResponse,
    AffiliateUnarchiveResponse,
)

Methods:

• client.affiliates.create(**params) -> Affiliate
• client.affiliates.retrieve(id) -> Affiliate
• client.affiliates.list(**params) -> SyncCursorPage[AffiliateListResponse]
• client.affiliates.archive(id) -> AffiliateArchiveResponse
• client.affiliates.unarchive(id) -> AffiliateUnarchiveResponse

Overrides

Types:

from whop_sdk.types.affiliates import (
    AffiliateAppliesToPayments,
    AffiliateAppliesToProducts,
    AffiliateOverrideRoles,
    AffiliatePayoutTypes,
    AffiliateRevenueBases,
    OverrideCreateResponse,
    OverrideRetrieveResponse,
    OverrideUpdateResponse,
    OverrideListResponse,
    OverrideDeleteResponse,
)

Methods:

• client.affiliates.overrides.create(path_id, **params) -> OverrideCreateResponse
• client.affiliates.overrides.retrieve(override_id, *, id) -> OverrideRetrieveResponse
• client.affiliates.overrides.update(override_id, *, id, **params) -> OverrideUpdateResponse
• client.affiliates.overrides.list(id, **params) -> SyncCursorPage[OverrideListResponse]
• client.affiliates.overrides.delete(override_id, *, id) -> OverrideDeleteResponse

Bounties

Types:

from whop_sdk.types import BountyCreateResponse, BountyRetrieveResponse, BountyListResponse

Methods:

• client.bounties.create(**params) -> BountyCreateResponse
• client.bounties.retrieve(id) -> BountyRetrieveResponse
• client.bounties.list(**params) -> SyncCursorPage[BountyListResponse]

Workforce

Bounties

Types:

from whop_sdk.types.workforce import WorkforceBounty, WorkforceBountyListItem

Methods:

• client.workforce.bounties.retrieve(id) -> WorkforceBounty
• client.workforce.bounties.list(**params) -> SyncCursorPage[WorkforceBountyListItem]

AdCampaigns

Types:

from whop_sdk.types import AdCampaign, AdCampaignDeleteResponse

Methods:

• client.ad_campaigns.create(**params) -> AdCampaign
• client.ad_campaigns.retrieve(id, **params) -> AdCampaign
• client.ad_campaigns.update(id, **params) -> AdCampaign
• client.ad_campaigns.list(**params) -> SyncCursorPage[AdCampaign]
• client.ad_campaigns.delete(id) -> AdCampaignDeleteResponse
• client.ad_campaigns.pause(id) -> AdCampaign
• client.ad_campaigns.unpause(id) -> AdCampaign

AdGroups

Types:

from whop_sdk.types import AdGroup, AdGroupDeleteResponse

Methods:

• client.ad_groups.create(**params) -> AdGroup
• client.ad_groups.retrieve(id, **params) -> AdGroup
• client.ad_groups.update(id, **params) -> AdGroup
• client.ad_groups.list(**params) -> SyncCursorPage[AdGroup]
• client.ad_groups.delete(id) -> AdGroupDeleteResponse
• client.ad_groups.pause(id) -> AdGroup
• client.ad_groups.unpause(id) -> AdGroup

Ads

Types:

from whop_sdk.types import Ad, AdDeleteResponse

Methods:

• client.ads.create(**params) -> Ad
• client.ads.retrieve(id, **params) -> Ad
• client.ads.update(id, **params) -> Ad
• client.ads.list(**params) -> SyncCursorPage[Ad]
• client.ads.delete(id) -> AdDeleteResponse
• client.ads.pause(id) -> Ad
• client.ads.unpause(id) -> Ad

AdReports

Types:

from whop_sdk.types import Granularities, ResultLabelKeys, AdReportRetrieveResponse

Methods:

• client.ad_reports.retrieve(**params) -> AdReportRetrieveResponse