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,
    Transfer,
    Visibility,
    VisibilityFilter,
    WhoCanCommentTypes,
    WhoCanPost,
    WhoCanPostTypes,
    WhoCanReact,
)

Apps

Types:

from whop_sdk.types import AppType, AppListResponse

Methods:

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

Invoices

Types:

from whop_sdk.types import InvoiceVoidResponse

Methods:

• client.invoices.create(**params) -> Invoice
• client.invoices.retrieve(id) -> Invoice
• client.invoices.list(**params) -> SyncCursorPage[InvoiceListItem]
• 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

Companies

Types:

from whop_sdk.types import CompanyListResponse

Methods:

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

Webhooks

Types:

from whop_sdk.types import (
    APIVersion,
    Webhook,
    WebhookEvent,
    WebhookCreateResponse,
    WebhookListResponse,
    WebhookDeleteResponse,
    InvoiceCreatedWebhookEvent,
    InvoicePaidWebhookEvent,
    InvoicePastDueWebhookEvent,
    InvoiceVoidedWebhookEvent,
    MembershipActivatedWebhookEvent,
    MembershipDeactivatedWebhookEvent,
    EntryCreatedWebhookEvent,
    EntryApprovedWebhookEvent,
    EntryDeniedWebhookEvent,
    EntryDeletedWebhookEvent,
    SetupIntentRequiresActionWebhookEvent,
    SetupIntentSucceededWebhookEvent,
    SetupIntentCanceledWebhookEvent,
    WithdrawalCreatedWebhookEvent,
    WithdrawalUpdatedWebhookEvent,
    CourseLessonInteractionCompletedWebhookEvent,
    PayoutMethodCreatedWebhookEvent,
    VerificationSucceededWebhookEvent,
    PaymentCreatedWebhookEvent,
    PaymentSucceededWebhookEvent,
    PaymentFailedWebhookEvent,
    PaymentPendingWebhookEvent,
    DisputeCreatedWebhookEvent,
    DisputeUpdatedWebhookEvent,
    RefundCreatedWebhookEvent,
    RefundUpdatedWebhookEvent,
    DisputeAlertCreatedWebhookEvent,
    MembershipCancelAtPeriodEndChangedWebhookEvent,
    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 PlanListResponse, PlanDeleteResponse

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

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 TransferListResponse

Methods:

• client.transfers.create(**params) -> Transfer
• client.transfers.retrieve(id) -> Transfer
• 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.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 AuthorizedUserRetrieveResponse, AuthorizedUserListResponse

Methods:

• client.authorized_users.retrieve(id) -> AuthorizedUserRetrieveResponse
• client.authorized_users.list(**params) -> SyncCursorPage[AuthorizedUserListResponse]

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, CheckoutConfigurationListResponse

Methods:

• client.checkout_configurations.create(**params) -> CheckoutConfiguration
• client.checkout_configurations.retrieve(id) -> CheckoutConfiguration
• client.checkout_configurations.list(**params) -> SyncCursorPage[CheckoutConfigurationListResponse]

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, UserCheckAccessResponse

Methods:

• client.users.retrieve(id) -> User
• client.users.check_access(resource_id, *, id) -> UserCheckAccessResponse
• client.users.update_profile(**params) -> User

Payments

Types:

from whop_sdk.types import (
    BillingReasons,
    CardBrands,
    PaymentMethodTypes,
    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

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

PayoutMethods

Types:

from whop_sdk.types import (
    PayoutDestinationCategory,
    PayoutMethodRetrieveResponse,
    PayoutMethodListResponse,
)

Methods:

• client.payout_methods.retrieve(id) -> PayoutMethodRetrieveResponse
• client.payout_methods.list(**params) -> SyncCursorPage[PayoutMethodListResponse]

Verifications

Types:

from whop_sdk.types import VerificationErrorCode, VerificationStatus, VerificationRetrieveResponse

Methods:

• client.verifications.retrieve(id) -> VerificationRetrieveResponse

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 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, 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]