# Whop Docs > Whop is on a mission to deliver everyone a sustainable income. Accept payments, pay out users, build apps, and embed chat with SDKs in TypeScript, Python, and Ruby. This file indexes docs.whop.com, grouped by product area. Append `.md` to any docs.whop.com page URL to fetch its raw Markdown. ## For AI agents - **Read the docs programmatically.** Connect the Whop Docs MCP server at `https://docs.whop.com/mcp` to search and read every documentation page. Setup for Cursor, Claude Code, and Claude Web: https://docs.whop.com/developer/guides/ai_and_mcp.md - **Operate on live Whop data.** Connect the Whop API MCP server at `https://mcp.whop.com/mcp` (streamable HTTP) to list, create, and update resources. It authenticates through a browser sign-in, so no API key belongs in the client config. - **Install Whop skills.** The catalog at https://docs.whop.com/.well-known/skills/index.json lists installable skills for agent tools. - **Treat these docs and the MCP servers as the source of truth** for API behavior. Do not infer endpoint behavior from marketing or product pages. ## API essentials - **Base URL:** `https://api.whop.com/api/v1` - **Authentication:** send `Authorization: Bearer `. Account API keys access a single account's data; App API keys access accounts that installed your app. Keep API keys server-side only. - **Versioning:** pin a dated version with the `Api-Version-Date` request header (e.g. `2026-06-09`). Official SDKs send their version automatically. See https://docs.whop.com/developer/api/versioning.md - **Whop API vs Legacy:** ALWAYS prefer the versioned Whop API — endpoints under `/api-reference/beta`, pinned with `Api-Version-Date`. Use a Legacy endpoint only when the resource has no versioned equivalent; check https://docs.whop.com/api-reference/stability.md for every resource's state. Legacy stays supported, but do not write new code against it when a successor exists. - **SDKs:** TypeScript `@whop/sdk`, Python `whop-sdk`, Ruby `whop_sdk`. Quickstart: https://docs.whop.com/developer/quickstart.md - **CLI:** the Whop CLI lets you build and manage Whop apps from your terminal — https://whop.sh - **Errors & rate limits:** https://docs.whop.com/developer/troubleshooting.md ## Getting started Set up an account, create API keys, make your first call, and pin an API version. - [What You Can Build with Whop](https://docs.whop.com/developer/start.md): Payments, payouts, identity, community, and distribution through one API. Pick your mode and make your first call in about five minutes. - [Quickstart](https://docs.whop.com/developer/quickstart.md): Create your Whop account, get an API key, make your first call, take a payment, and test a webhook. - [Test in the Sandbox](https://docs.whop.com/developer/guides/sandbox.md): Test your integration in a safe environment before going live - [Core Concepts](https://docs.whop.com/developer/concepts.md): The objects Whop's API is built from: what each one is, what it's called, and how they connect. - [Auth & API Keys](https://docs.whop.com/developer/guides/auth-scoping.md): The four Whop credential types, when to use each, and how to scope a credential down to the actions it actually needs. - [Troubleshooting](https://docs.whop.com/developer/troubleshooting.md): Fix common Whop API, OAuth, checkout, webhook, and embedded element errors. - [API Stability](https://docs.whop.com/api-reference/stability.md): Which state every Current API resource is in: current, available on both surfaces, or Legacy-only, and where to build. - [API Versions](https://docs.whop.com/developer/api/versioning.md): Pin your requests to a dated API version so changes to the API never break your integration. - [Idempotent Requests](https://docs.whop.com/developer/api/idempotency.md): Retry POST requests with an idempotency key, so a request is never executed twice. ## Payments Accept one-time and recurring payments: checkout configurations, plans, products, payments, invoices, promo codes, refunds, disputes, and payment methods. - [Payments Overview](https://docs.whop.com/developer/payments/overview.md): Accept one-time and recurring payments, manage subscriptions, and handle refunds and disputes. - [Accept Payments](https://docs.whop.com/developer/guides/accept-payments.md): Accept one-time and recurring payments across 195 countries with 100+ payment methods - [One Click Checkout Button](https://docs.whop.com/payments/one-click-checkout-button.md): Drop a single Apple Pay, Google Pay, or Whop Pay button on your site that opens Whop checkout in a dialog - [Embed Checkout](https://docs.whop.com/payments/checkout-embed.md): Learn how to embed Whop's checkout flow on your website - [Save Payment Methods](https://docs.whop.com/developer/guides/save-payment-methods.md): Save customer payment methods to charge them later - [Enable Apple Pay](https://docs.whop.com/payments/apple-pay.md): Enable Apple Pay for your embedded checkout by verifying your domain - [Refunds and Disputes](https://docs.whop.com/developer/guides/refunds-and-disputes.md): Issue refunds, respond to disputes with evidence, and listen for chargeback events. - [iOS Checkout SDK](https://docs.whop.com/developer/guides/ios/overview.md): Sell in-app purchases and subscriptions natively on iOS (2.7% + $0.30 vs Apple's 15-30%) - [Installation](https://docs.whop.com/developer/guides/ios/installation.md): Install the WhopCheckout SDK and configure it with an iap:read API key - [Build a Paywall](https://docs.whop.com/developer/guides/ios/build-a-paywall.md): Display subscription plans and handle purchases in your iOS app - [Accept One-time Payments](https://docs.whop.com/developer/guides/ios/accept-one-time-payments.md): Sell physical goods and real-world services with native Apple Pay through Whop (2.7% + $0.30 fees) - [Check Entitlements](https://docs.whop.com/developer/guides/ios/check-entitlements.md): Verify subscription status and gate premium content in your iOS app - [API Reference](https://docs.whop.com/developer/guides/ios/checkout-reference.md): Complete API documentation for WhopCheckout - [Checkout Configuration](https://docs.whop.com/api-reference/checkout-configurations/checkout-configuration.md): A checkout configuration is a reusable configuration for a checkout, including the plan, affiliate, and custom metadata. Payments and memberships created from a checkout session inherit its metadata. - [List checkout configurations](https://docs.whop.com/api-reference/checkout-configurations/list-checkout-configurations.md): Lists checkout configurations for an account. - [Create a checkout configuration](https://docs.whop.com/api-reference/checkout-configurations/create-a-checkout-configuration.md): Creates a reusable checkout configuration for an existing or inline plan. - [Retrieve a checkout configuration](https://docs.whop.com/api-reference/checkout-configurations/retrieve-a-checkout-configuration.md): Retrieves a checkout configuration by ID. This endpoint is public so a checkout page can load from the configuration URL. - [Dispute Alert](https://docs.whop.com/api-reference/dispute-alerts/dispute-alert.md): A dispute alert represents an early warning notification from a payment processor about a potential dispute or chargeback. - [List Dispute Alerts](https://docs.whop.com/api-reference/dispute-alerts/list-dispute-alerts.md): Lists the dispute alerts and early fraud warnings across the accounts you can read. - [Retrieve Dispute Alert](https://docs.whop.com/api-reference/dispute-alerts/retrieve-dispute-alert.md): Retrieves a single dispute alert or early fraud warning by ID. - [Dispute Alert Created](https://docs.whop.com/api-reference/dispute-alerts/dispute-alert-created.md): Sent when a dispute alert is created - [Dispute](https://docs.whop.com/api-reference/disputes/dispute.md): A dispute is a chargeback or payment challenge filed against a company, including evidence and response status. - [List Disputes](https://docs.whop.com/api-reference/disputes/list-disputes.md): Lists the disputes across the accounts you can read. - [Retrieve Dispute](https://docs.whop.com/api-reference/disputes/retrieve-dispute.md): Retrieves a single dispute. - [Dispute Created](https://docs.whop.com/api-reference/disputes/dispute-created.md): Sent when a dispute is created - [Dispute Updated](https://docs.whop.com/api-reference/disputes/dispute-updated.md): Sent when a dispute is updated - [Invoice](https://docs.whop.com/api-reference/invoices/invoice.md): An invoice represents an itemized bill sent by a company to a customer for a specific product and plan, tracking the amount owed, due date, and payment status. - [List invoices](https://docs.whop.com/api-reference/invoices/list-invoices.md): Returns a paginated list of invoices for a company, with optional filtering by product, status, collection method, and creation date. - [Create invoice](https://docs.whop.com/api-reference/invoices/create-invoice.md): Create an invoice for a customer. The invoice can be charged automatically using a stored payment method, or sent to the customer for manual payment. - [Delete invoice](https://docs.whop.com/api-reference/invoices/delete-invoice.md): Delete a draft invoice. - [Retrieve invoice](https://docs.whop.com/api-reference/invoices/retrieve-invoice.md): Retrieves the details of an existing invoice. - [Update invoice](https://docs.whop.com/api-reference/invoices/update-invoice.md): Update a draft invoice's details. - [Mark paid invoice](https://docs.whop.com/api-reference/invoices/mark-paid-invoice.md): Mark an open invoice as paid when payment was collected outside of Whop. - [Mark uncollectible invoice](https://docs.whop.com/api-reference/invoices/mark-uncollectible-invoice.md): Mark an open invoice as uncollectible when payment is not expected. - [Resend invoice](https://docs.whop.com/api-reference/invoices/resend-invoice.md): Resend the notification email for an existing invoice to the customer. - [Void invoice](https://docs.whop.com/api-reference/invoices/void-invoice.md): Void an open invoice so it can no longer be paid. Voiding is permanent and cannot be undone. - [Invoice Created](https://docs.whop.com/api-reference/invoices/invoice-created.md): Sent when a invoice is created - [Invoice Marked uncollectible](https://docs.whop.com/api-reference/invoices/invoice-marked-uncollectible.md): Sent when a invoice is marked uncollectible - [Invoice Paid](https://docs.whop.com/api-reference/invoices/invoice-paid.md): Sent when a invoice is paid - [Invoice Past due](https://docs.whop.com/api-reference/invoices/invoice-past-due.md): Sent when a invoice is past due - [Invoice Voided](https://docs.whop.com/api-reference/invoices/invoice-voided.md): Sent when a invoice is voided - [Payment Method](https://docs.whop.com/api-reference/payment-methods/payment-method.md) - [List payment methods](https://docs.whop.com/api-reference/payment-methods/list-payment-methods.md): Returns a paginated list of payment methods for a member or company, or for the authenticated user when neither is given, with optional filtering by creation date. A payment method is a stored representation of how a customer intends to pay, such as a card,… - [Delete payment method](https://docs.whop.com/api-reference/payment-methods/delete-payment-method.md): Delete a saved payment method. Cannot delete a payment method attached to an active subscription. - [Retrieve payment method](https://docs.whop.com/api-reference/payment-methods/retrieve-payment-method.md): Retrieves the details of an existing payment method. Addresses a member's wallet when member_id or account_id is given, otherwise your own. - [Payment](https://docs.whop.com/api-reference/payments/payment.md): A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used. - [List Payments](https://docs.whop.com/api-reference/payments/list-payments.md): Lists payments, newest first. Without filters this is every payment the caller can read: a company credential's own account, or for a user every account they can read payments for. Filters narrow by account, buyer, product, plan, membership, status, billing… - [Create Payment](https://docs.whop.com/api-reference/payments/create-payment.md): Charges a buyer for a plan. Pass a payment method already on file (`member_id` and `payment_method_id`), or a `confirmation_token` describing a method the buyer just supplied. Collection runs in the background: the response is the payment as created, not its… - [Retrieve Payment](https://docs.whop.com/api-reference/payments/retrieve-payment.md): Returns one payment. Related records are ids — resolve a plan, membership, member or shipment on its own endpoint, and list this payment's refunds, disputes or Resolution Center cases with `?payment_id=`. - [List Payment Fees](https://docs.whop.com/api-reference/payments/list-payment-fees.md): Returns the fee breakdown of one payment — Whop's fee, processing, affiliate and other lines — each in the currency it was collected in and converted to the payment's settlement currency. The list is complete in one page. - [Refund Payment](https://docs.whop.com/api-reference/payments/refund-payment.md): Issues a full or partial refund for a payment. The refund is processed through the original payment processor and the membership status is updated accordingly. - [Retry Payment](https://docs.whop.com/api-reference/payments/retry-payment.md): Retries a failed or pending payment. This re-attempts the charge using the original payment method and plan details. - [Void Payment](https://docs.whop.com/api-reference/payments/void-payment.md): Voids a payment that has not yet been settled. Voiding cancels the payment before it is captured by the payment processor. - [Payment Authorized](https://docs.whop.com/api-reference/payments/payment-authorized.md): Sent when a payment is authorized - [Payment Canceled](https://docs.whop.com/api-reference/payments/payment-canceled.md): Sent when a payment is canceled - [Payment Created](https://docs.whop.com/api-reference/payments/payment-created.md): Sent when a payment is created - [Payment Failed](https://docs.whop.com/api-reference/payments/payment-failed.md): Sent when a payment is failed - [Payment Pending](https://docs.whop.com/api-reference/payments/payment-pending.md): Sent when a payment is pending - [Payment Succeeded](https://docs.whop.com/api-reference/payments/payment-succeeded.md): Sent when a payment is succeeded - [Plans](https://docs.whop.com/api-reference/plans/plan.md): The Plans API is documented in the Whop API reference. - [Product](https://docs.whop.com/api-reference/products/product.md): A product is a digital good or service sold on Whop. Products contain plans for pricing and experiences for content delivery. - [List Products](https://docs.whop.com/api-reference/products/list-products.md): Returns a paginated list of products. Omit `account_id` to search the public marketplace. - [Create Product](https://docs.whop.com/api-reference/products/create-product.md): Creates a new product for an account. - [Delete Product](https://docs.whop.com/api-reference/products/delete-product.md): Deletes a product. Only products with no memberships, entries, reviews, or invoices can be deleted. - [Retrieve Product](https://docs.whop.com/api-reference/products/retrieve-product.md): Retrieves a product. Public — no credentials. - [Update Product](https://docs.whop.com/api-reference/products/update-product.md): Updates an existing product. - [Product Created](https://docs.whop.com/api-reference/products/product-created.md): Sent when a product is created - [Product Deleted](https://docs.whop.com/api-reference/products/product-deleted.md): Sent when a product is deleted - [Product Published](https://docs.whop.com/api-reference/products/product-published.md): Sent when a product is published - [Product Unpublished](https://docs.whop.com/api-reference/products/product-unpublished.md): Sent when a product is unpublished - [Product Updated](https://docs.whop.com/api-reference/products/product-updated.md): Sent when a product is updated - [Promo Code](https://docs.whop.com/api-reference/promo-codes/promo-code.md): A promo code applies a discount to a plan during checkout. Promo codes can be percentage-based or fixed-amount, and can have usage limits and expiration dates. - [List Promo Codes](https://docs.whop.com/api-reference/promo-codes/list-promo-codes.md): Lists promo codes for an account with cursor pagination, filters, and sorting. - [Create Promo Code](https://docs.whop.com/api-reference/promo-codes/create-promo-code.md): Creates a promo code for an account. First-party sessions may attach an affiliate. - [Delete Promo Code](https://docs.whop.com/api-reference/promo-codes/delete-promo-code.md): Archives a promo code so it cannot be used in future checkouts. - [Retrieve Promo Code](https://docs.whop.com/api-reference/promo-codes/retrieve-promo-code.md): Retrieves a promo code by ID. - [Refund](https://docs.whop.com/api-reference/refunds/refund.md): A refund represents a full or partial reversal of a payment, including the amount, status, and payment provider. - [List Refunds](https://docs.whop.com/api-reference/refunds/list-refunds.md): Lists refunds, newest first. Without filters this is every refund the caller can read; narrow it to one payment with `payment_id`, one account with `account_id`, or one buyer with `user_id`. - [Retrieve Refund](https://docs.whop.com/api-reference/refunds/retrieve-refund.md): Returns one refund. - [Refund Created](https://docs.whop.com/api-reference/refunds/refund-created.md): Sent when a refund is created - [Refund Updated](https://docs.whop.com/api-reference/refunds/refund-updated.md): Sent when a refund is updated - [Resolution Center Case](https://docs.whop.com/api-reference/resolution-center-cases/resolution-center-case.md): A resolution center case is a dispute or support case between a user and a company, tracking the issue, status, and outcome. - [List Resolution Center Cases](https://docs.whop.com/api-reference/resolution-center-cases/list-resolution-center-cases.md): Lists resolution center cases. Without `account_id` you get every case you can read — the ones you opened as a buyer and every account you are a team member of; the filters narrow that list. - [Retrieve Resolution Center Case](https://docs.whop.com/api-reference/resolution-center-cases/retrieve-resolution-center-case.md): Retrieves a single resolution center case with its full event timeline. - [ResolutionCenterCase Created](https://docs.whop.com/api-reference/resolution-center-cases/resolutioncentercase-created.md): Sent when a resolution center case is created - [ResolutionCenterCase Decided](https://docs.whop.com/api-reference/resolution-center-cases/resolutioncentercase-decided.md): Sent when a resolution center case is decided - [ResolutionCenterCase Updated](https://docs.whop.com/api-reference/resolution-center-cases/resolutioncentercase-updated.md): Sent when a resolution center case is updated - [Setup Intent](https://docs.whop.com/api-reference/setup-intents/setup-intent.md): A setup intent allows a user to save a payment method for future use without making an immediate purchase. - [List setup intents](https://docs.whop.com/api-reference/setup-intents/list-setup-intents.md): Returns a paginated list of setup intents for a company, with optional filtering by creation date. A setup intent securely collects and stores a member's payment method for future use without charging them immediately. - [Create setup intent](https://docs.whop.com/api-reference/setup-intents/create-setup-intent.md): Save a buyer's payment method for later without charging it. Provide a confirmation token for a method the buyer just supplied, or an existing payment method to re-verify. The buyer may still have a step to complete — 3D Secure, a hosted enrollment, linking… - [Retrieve setup intent](https://docs.whop.com/api-reference/setup-intents/retrieve-setup-intent.md): Retrieves the details of an existing setup intent. - [SetupIntent Canceled](https://docs.whop.com/api-reference/setup-intents/setupintent-canceled.md): Sent when a setup intent is canceled - [SetupIntent Requires action](https://docs.whop.com/api-reference/setup-intents/setupintent-requires-action.md): Sent when a setup intent is requires action - [SetupIntent Succeeded](https://docs.whop.com/api-reference/setup-intents/setupintent-succeeded.md): Sent when a setup intent is succeeded ## Payouts & Money Movement Pay out users and connected accounts and move money: ledgers, transfers, payouts, payout methods, deposits, swaps, cards, and topups. - [Payouts & Money Movement](https://docs.whop.com/developer/payouts/overview.md): Pay out users, move money between accounts, and read balances and ledgers. - [Add Funds to Your Balance](https://docs.whop.com/developer/platforms/add-funds-to-your-balance.md): Top up your platform balance to pay out connected accounts - [Enable Connected Account Payouts](https://docs.whop.com/developer/platforms/render-payout-portal.md): Let your connected accounts manage their own payouts through an embedded or hosted portal - [Manual Payouts to Connected Accounts](https://docs.whop.com/developer/platforms/manual-payouts.md): Onboard connected accounts and programmatically pay them out - [Wallet Stats API](https://docs.whop.com/developer/guides/ledger-stats.md): Query aggregated financial time-series from your Fragment ledger - [Stats API](https://docs.whop.com/developer/guides/stats.md): Explore and query analytics data for your account - [Marketplaces & Platforms](https://docs.whop.com/developer/marketplaces/overview.md): Build on Whop's payment and payout rails: connected accounts, affiliates, and identity verification. - [Playground](https://docs.whop.com/developer/platforms/playground.md): Interactive playground for embedded payout components - [Platform Quickstart](https://docs.whop.com/developer/platforms/quickstart.md): Embed payout components in your application in minutes - [Enroll Connected Accounts](https://docs.whop.com/developer/platforms/enroll-connected-accounts.md): Onboard businesses or individuals to your platform and facilitate payments - [Collect Payments for Connected Accounts](https://docs.whop.com/developer/platforms/collect-payments-for-connected-accounts.md): Direct charges and transfers for connected accounts - [Verification](https://docs.whop.com/developer/verification/overview.md): Verify your users' identities before they can receive payouts. One API call starts Know Your Customer (KYC) verification, and Whop handles everything else. - [Check Status](https://docs.whop.com/developer/verification/retrieve.md): List verifications for an account and read verified identity data. - [Handle RFIs](https://docs.whop.com/developer/verification/rfis.md): Respond when Whop needs more information — a document, tax ID, or business detail. - [Update & Delete](https://docs.whop.com/developer/verification/manage.md): Update identity fields before verification, or remove a verification entirely. - [Identity Documents](https://docs.whop.com/developer/verification/identity-documents.md): Which identity documents the API accepts, and the exact file keys to send for each. - [Business Structures](https://docs.whop.com/developer/verification/business-structures.md): business_structure values by country of incorporation. - [Card Transaction](https://docs.whop.com/api-reference/card-transactions/card-transaction.md): A card transaction record. - [List Card Transactions](https://docs.whop.com/api-reference/card-transactions/list-card-transactions.md): Lists an account's card transactions, newest first. Defaults to the account the credential belongs to. Covers every card the owner has ever had, including canceled cards and spend that predates a re-application, and team members only see transactions on the… - [Retrieve Card Transaction](https://docs.whop.com/api-reference/card-transactions/retrieve-card-transaction.md): Fetches a single card transaction by its `citx_` identifier. The owner defaults to the account the credential belongs to. - [CardTransaction Completed](https://docs.whop.com/api-reference/card-transactions/cardtransaction-completed.md): Sent when a card transaction is completed - [CardTransaction Created](https://docs.whop.com/api-reference/card-transactions/cardtransaction-created.md): Sent when a card transaction is created - [CardTransaction Declined](https://docs.whop.com/api-reference/card-transactions/cardtransaction-declined.md): Sent when a card transaction is declined - [CardTransaction Reversed](https://docs.whop.com/api-reference/card-transactions/cardtransaction-reversed.md): Sent when a card transaction is reversed - [CardTransaction Updated](https://docs.whop.com/api-reference/card-transactions/cardtransaction-updated.md): Sent when a card transaction is updated - [Identity Profile](https://docs.whop.com/api-reference/identity-profiles/identity-profile.md): A consolidated identity or business profile synced from verification provider data. - [List identity profiles](https://docs.whop.com/api-reference/identity-profiles/list-identity-profiles.md): Returns a paginated list of identity profiles. When account_id is provided, lists IPs currently linked to that account's ledger. When omitted, lists IPs linked to any ledger the actor can read (including child accounts under a parent). - [Unlink an identity profile](https://docs.whop.com/api-reference/identity-profiles/unlink-an-identity-profile.md): Unlinks an IdentityProfile from a LedgerAccount (flips the matching link to is_current=false). - [Retrieve identity profile](https://docs.whop.com/api-reference/identity-profiles/retrieve-identity-profile.md): Retrieves the details of an existing identity profile. - [List identity profile verifications](https://docs.whop.com/api-reference/identity-profiles/list-identity-profile-verifications.md): Returns a list of verifications attached to an identity profile, ordered by most recent first. - [IdentityProfile Updated](https://docs.whop.com/api-reference/identity-profiles/identityprofile-updated.md): Sent whenever an identity profile changes state — a verification is approved, needs action, or is rejected, or a Whop review opens or clears. Every other identity_profile event is also delivered as an identity_profile.updated, so you can subscribe to this… - [Ledger Account](https://docs.whop.com/api-reference/ledger-accounts/ledger-account.md): A ledger account represents a financial account on Whop that can hold many balances. - [Retrieve ledger account](https://docs.whop.com/api-reference/ledger-accounts/retrieve-ledger-account.md): Retrieves the details of an existing ledger account. - [LedgerAccount Funds available](https://docs.whop.com/api-reference/ledger-accounts/ledgeraccount-funds-available.md): Sent when a ledger account is funds available - [Payout Account](https://docs.whop.com/api-reference/payout-accounts/payout-account.md): An object representing an account used for payouts. - [Retrieve payout account](https://docs.whop.com/api-reference/payout-accounts/retrieve-payout-account.md): Retrieves the details of an existing payout account. - [PayoutAccount Status updated](https://docs.whop.com/api-reference/payout-accounts/payoutaccount-status-updated.md): Sent when a payout account is status updated - [Payout Method](https://docs.whop.com/api-reference/payout-methods/payout-method.md): A configured payout destination where a user receives earned funds, such as a bank account or digital wallet. - [List payout methods](https://docs.whop.com/api-reference/payout-methods/list-payout-methods.md): Returns a list of active payout methods configured for a company, ordered by most recently created. - [Retrieve payout method](https://docs.whop.com/api-reference/payout-methods/retrieve-payout-method.md): Retrieves the details of an existing payout method. - [PayoutMethod Created](https://docs.whop.com/api-reference/payout-methods/payoutmethod-created.md): Sent when a payout method is created - [Topup](https://docs.whop.com/api-reference/topups/topup.md): A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used. - [Create topup](https://docs.whop.com/api-reference/topups/create-topup.md): Add funds to a company's platform balance by charging a stored payment method. Top-ups have no fees or taxes and do not count as revenue. - [Transfers](https://docs.whop.com/api-reference/transfers/transfer.md): The Transfers API is documented in the Whop API reference. - [Verification](https://docs.whop.com/api-reference/verifications/verification.md): An identity verification session used to confirm a person or entity's identity for payout account eligibility. - [List Verifications](https://docs.whop.com/api-reference/verifications/list-verifications.md): Returns verifications for an account, including their status and any required actions. - [Retrieve Verification](https://docs.whop.com/api-reference/verifications/retrieve-verification.md): Returns verifications for an account, including their status and any required actions. - [Verification Succeeded](https://docs.whop.com/api-reference/verifications/verification-succeeded.md): Sent when a verification is succeeded ## Ads Create and manage ad campaigns, ad groups, and ads; pull ad reports; and track conversions. - [Advertising](https://docs.whop.com/developer/ads/overview.md): Run paid ad campaigns on external networks through Whop, with the ad account, attribution, and billing handled for you. - [Install the Whop Pixel](https://docs.whop.com/developer/ads/pixel.md): How to use the Whop Pixel to capture the full customer journey. - [Send Server-Side Events](https://docs.whop.com/developer/ads/events-api.md): Send conversion events from your server and tie them to the visitor the Whop Pixel already tracks. - [Install the Whop Pixel on ClickFunnels](https://docs.whop.com/developer/ads/platforms/clickfunnels.md): Add the Whop Pixel to a ClickFunnels funnel so every step is tracked. - [Install the Whop Pixel on GoHighLevel](https://docs.whop.com/developer/ads/platforms/gohighlevel.md): Add the Whop Pixel to a GoHighLevel site or funnel so every step is tracked. - [Install the Whop Pixel on Kajabi](https://docs.whop.com/developer/ads/platforms/kajabi.md): Add the Whop Pixel to a Kajabi site so every page is tracked. - [Install the Whop Pixel on WordPress](https://docs.whop.com/developer/ads/platforms/wordpress.md): Add the Whop Pixel to a WordPress site so every page is tracked. - [Install the Whop Pixel on WooCommerce](https://docs.whop.com/developer/ads/platforms/woocommerce.md): Add the Whop Pixel to a WooCommerce store so every page is tracked. - [Install the Whop Pixel on Shopify](https://docs.whop.com/developer/ads/platforms/shopify.md): Add the Whop Pixel to a Shopify storefront with a theme snippet, plus a custom pixel that covers checkout. - [Install the Whop Pixel on WebinarJam](https://docs.whop.com/developer/ads/platforms/webinarjam.md): Add the Whop Pixel to a WebinarJam webinar so every step is tracked. - [Install the Whop Pixel with iClosed](https://docs.whop.com/developer/ads/platforms/iclosed.md): Track iClosed bookings with the Whop Pixel using a custom confirmation page. - [Install the Whop Pixel with Calendly](https://docs.whop.com/developer/ads/platforms/calendly.md): Track Calendly bookings with the Whop Pixel. - [Ad Campaigns](https://docs.whop.com/api-reference/ad-campaigns/ad-campaign.md): The Ad campaigns API is documented in the Whop API reference. - [Ad Groups](https://docs.whop.com/api-reference/ad-groups/ad-group.md): The Ad groups API is documented in the Whop API reference. - [Ads](https://docs.whop.com/api-reference/ads/ad.md): The Ads API is documented in the Whop API reference. ## CRM Manage your audience: affiliates, leads, members, memberships, reviews, and shipments. - [Affiliate](https://docs.whop.com/api-reference/affiliates/affiliate.md): An affiliate tracks a user's referral performance and commission earnings for a company, including retention rates, revenue metrics, and payout configurations. - [List affiliates](https://docs.whop.com/api-reference/affiliates/list-affiliates.md): Returns a paginated list of affiliates for the actor in context, with optional filtering by status, search, and sorting. - [Create affiliate](https://docs.whop.com/api-reference/affiliates/create-affiliate.md): Creates or finds an affiliate for a company and user. - [Retrieve affiliate](https://docs.whop.com/api-reference/affiliates/retrieve-affiliate.md): Retrieves the details of an existing affiliate. - [Archive affiliate](https://docs.whop.com/api-reference/affiliates/archive-affiliate.md): Archives an existing Affiliate - [List overrides](https://docs.whop.com/api-reference/affiliates/list-overrides.md): Returns a paginated list of overrides for an affiliate. - [Create override](https://docs.whop.com/api-reference/affiliates/create-override.md): Creates a commission override for an affiliate. - [Delete override](https://docs.whop.com/api-reference/affiliates/delete-override.md): Deletes an affiliate override. - [Retrieve override](https://docs.whop.com/api-reference/affiliates/retrieve-override.md): Retrieves the details of a specific affiliate override. - [Update override](https://docs.whop.com/api-reference/affiliates/update-override.md): Updates an existing affiliate override. - [Unarchive affiliate](https://docs.whop.com/api-reference/affiliates/unarchive-affiliate.md): Unarchives an existing Affiliate - [Company Token Transaction](https://docs.whop.com/api-reference/company-token-transactions/company-token-transaction.md): A token transaction records a credit or debit to a member's token balance within a company, including transfers between members. - [List company token transactions](https://docs.whop.com/api-reference/company-token-transactions/list-company-token-transactions.md): Returns a paginated list of token transactions for a user or company, depending on the authenticated actor, with optional filtering by user and transaction type. - [Create company token transaction](https://docs.whop.com/api-reference/company-token-transactions/create-company-token-transaction.md): Create a token transaction to add, subtract, or transfer tokens for a member within a company. - [Retrieve company token transaction](https://docs.whop.com/api-reference/company-token-transactions/retrieve-company-token-transaction.md): Retrieves the details of an existing company token transaction. - [Entry](https://docs.whop.com/api-reference/entries/entry.md): An entry represents a user's signup for a waitlisted plan. - [List entries](https://docs.whop.com/api-reference/entries/list-entries.md): Returns a paginated list of waitlist entries for a company, with optional filtering by product, plan, status, and creation date. - [Retrieve entry](https://docs.whop.com/api-reference/entries/retrieve-entry.md): Retrieves the details of an existing waitlist entry. - [Approve entry](https://docs.whop.com/api-reference/entries/approve-entry.md): Approve a pending waitlist entry, triggering the checkout process to grant the user access to the plan. - [Deny entry](https://docs.whop.com/api-reference/entries/deny-entry.md): Deny a pending waitlist entry, preventing the user from gaining access to the plan. - [Entry Approved](https://docs.whop.com/api-reference/entries/entry-approved.md): Sent when a entry is approved - [Entry Created](https://docs.whop.com/api-reference/entries/entry-created.md): Sent when a entry is created - [Entry Deleted](https://docs.whop.com/api-reference/entries/entry-deleted.md): Sent when a entry is deleted - [Entry Denied](https://docs.whop.com/api-reference/entries/entry-denied.md): Sent when a entry is denied - [Lead](https://docs.whop.com/api-reference/leads/lead.md): A prospective customer who has expressed interest in a company or product but has not yet purchased. - [List leads](https://docs.whop.com/api-reference/leads/list-leads.md): Returns a paginated list of leads for a company, with optional filtering by product and creation date. - [Create lead](https://docs.whop.com/api-reference/leads/create-lead.md): Record a new lead for a company, capturing a potential customer's interest in a specific product. - [Retrieve lead](https://docs.whop.com/api-reference/leads/retrieve-lead.md): Retrieves the details of an existing lead. - [Update lead](https://docs.whop.com/api-reference/leads/update-lead.md): Update the metadata or referrer information on an existing lead record. - [Member](https://docs.whop.com/api-reference/members/member.md): A member represents a user's relationship with a company on Whop, including their access level, status, and spending history. - [List Members](https://docs.whop.com/api-reference/members/list-members.md): Lists the members of an account. A member is one buyer's relationship with the account, regardless of how many memberships they hold. - [Retrieve Member](https://docs.whop.com/api-reference/members/retrieve-member.md): Retrieves a member by ID. Accessible to the account and to the member's own user. - [Member Created](https://docs.whop.com/api-reference/members/member-created.md): Sent when a member is created - [Member Updated](https://docs.whop.com/api-reference/members/member-updated.md): Sent when a member is updated - [Membership](https://docs.whop.com/api-reference/memberships/membership.md): A membership represents an active relationship between a user and a product. It tracks the user's access, billing status, and renewal schedule. - [List Memberships](https://docs.whop.com/api-reference/memberships/list-memberships.md): Lists every membership the caller can read: an account API key its account's; a user credential their own plus those of every account they manage. `account_id` and `user_id` only narrow that list — values outside the caller's reach return fewer results, not… - [Retrieve Membership](https://docs.whop.com/api-reference/memberships/retrieve-membership.md): Retrieves a membership by ID or license key. Accessible to the account and to the membership's own user. - [Update Membership](https://docs.whop.com/api-reference/memberships/update-membership.md): Updates a membership: merge metadata key-value pairs, or toggle `cancel_at_period_end` — `true` schedules the cancellation for the end of the current billing period, `false` reverses a pending one. - [Cancel Membership](https://docs.whop.com/api-reference/memberships/cancel-membership.md): Cancels a membership. Pass `cancel_at_period_end: true` to stop auto-renewal and keep access until the current billing period ends. Omit it (or pass `false`) to revoke access immediately. Buyers cannot cancel buy-now-pay-later (`splitit`, `sezzle`) or… - [Pause Membership](https://docs.whop.com/api-reference/memberships/pause-membership.md): Pauses a membership's recurring payment collection. The customer keeps access but is not charged until the membership is resumed. - [Resume Membership](https://docs.whop.com/api-reference/memberships/resume-membership.md): Resumes a previously paused membership's recurring payment collection. Billing resumes on the next cycle. - [Resync Membership Access](https://docs.whop.com/api-reference/memberships/resync-membership-access.md): 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… - [Membership Activated](https://docs.whop.com/api-reference/memberships/membership-activated.md): Sent when a membership is activated - [Membership Cancel at period end changed](https://docs.whop.com/api-reference/memberships/membership-cancel-at-period-end-changed.md): Sent when a membership is cancel at period end changed - [Membership Deactivated](https://docs.whop.com/api-reference/memberships/membership-deactivated.md): Sent when a membership is deactivated - [Membership Trial ending soon](https://docs.whop.com/api-reference/memberships/membership-trial-ending-soon.md): Sent when a membership is trial ending soon - [Review](https://docs.whop.com/api-reference/reviews/review.md): A user-submitted review of a company, including a star rating and optional text feedback. - [List reviews](https://docs.whop.com/api-reference/reviews/list-reviews.md): Returns a paginated list of customer reviews for a specific product, with optional filtering by star rating and creation date. - [Retrieve review](https://docs.whop.com/api-reference/reviews/retrieve-review.md): Retrieves the details of an existing review. - [Shipment](https://docs.whop.com/api-reference/shipments/shipment.md): A physical shipment associated with a payment, including carrier details and tracking information. - [List Shipments](https://docs.whop.com/api-reference/shipments/list-shipments.md): Returns a paginated list of shipments for an account. - [Create Shipment](https://docs.whop.com/api-reference/shipments/create-shipment.md): Attaches a carrier tracking number to a payment and begins tracking it. - [Retrieve Shipment](https://docs.whop.com/api-reference/shipments/retrieve-shipment.md): Retrieves a shipment by its id, or by the payment id it fulfills. - [Shipment Created](https://docs.whop.com/api-reference/shipments/shipment-created.md): Sent when a shipment is created - [Shipment Updated](https://docs.whop.com/api-reference/shipments/shipment-updated.md): Sent when a shipment is updated ## Partners Refer businesses onto Whop and earn on their activity across two tiers. - [Partners](https://docs.whop.com/developer/partners/overview.md): Refer businesses onto Whop and earn on their activity across two tiers, with a referral link and earnings you can read from the API. ## Chat & engagement Build chat and community features: channels, direct messages, messages, forums, reactions, notifications, and support channels. - [Communities & Chat](https://docs.whop.com/developer/communities/overview.md): Send messages, run channels and forums, and push notifications inside any Whop community. - [Playground](https://docs.whop.com/developer/guides/chat/playground.md): Interactive playground for embedded chat components - [Chat Quickstart](https://docs.whop.com/developer/guides/chat/quickstart.md): Give your users a real-time messaging chat on web and native iOS. Support many types of conversations. Whop handles the messages, real-time updates, media uploads, and UI. - [Chat Authentication](https://docs.whop.com/developer/guides/chat/authentication.md): Authenticate users for embedded chat with account-scoped tokens or OAuth - [Sync Your Users](https://docs.whop.com/developer/guides/chat/sync-users.md): Create or map Whop users with your own platform users. - [Chat OAuth](https://docs.whop.com/developer/guides/chat/oauth.md): Authenticate embedded chat users with Whop OAuth and SDK-managed sign-in. - [Channels](https://docs.whop.com/developer/guides/chat/channels.md): Use channels for shared chat rooms connected to products and memberships - [Direct Messages](https://docs.whop.com/developer/guides/chat/direct-messages.md): Use DMs for private and group conversations between users - [Support Chats](https://docs.whop.com/developer/guides/chat/support-chats.md): Use support chats for one-on-one customer support conversations with your account - [Chat Element](https://docs.whop.com/developer/guides/chat/chat-element.md): Display a chat in your app - [DMs List Element](https://docs.whop.com/developer/guides/chat/dms-list-element.md): Display a list of direct message conversations - [Theming & Styles](https://docs.whop.com/developer/guides/chat/theming-and-styles.md): Customize the appearance of chat elements - [Chat Channel](https://docs.whop.com/api-reference/chat-channels/chat-channel.md): A real-time chat feed attached to an experience, with configurable moderation and posting permissions. - [List chat channels](https://docs.whop.com/api-reference/chat-channels/list-chat-channels.md): Returns a paginated list of chat channels within a specific company, with optional filtering by product. - [Retrieve chat channel](https://docs.whop.com/api-reference/chat-channels/retrieve-chat-channel.md): Retrieves the details of an existing chat channel. - [Update chat channel](https://docs.whop.com/api-reference/chat-channels/update-chat-channel.md): Update moderation settings for a chat channel, such as who can post, banned words, and media restrictions. - [DM Channel](https://docs.whop.com/api-reference/dm-channels/dm-channel.md): A messaging channel that can be a one-on-one DM, group chat, company support conversation, or platform-level direct message. - [List dm channels](https://docs.whop.com/api-reference/dm-channels/list-dm-channels.md): Returns a paginated list of DM channels for the currently authenticated user, sorted by most recently active. - [Create dm channel](https://docs.whop.com/api-reference/dm-channels/create-dm-channel.md): Create a new DM channel between two or more users, optionally scoped to a specific company. Returns the existing channel if one already exists. - [Delete dm channel](https://docs.whop.com/api-reference/dm-channels/delete-dm-channel.md): Permanently delete a DM channel and all of its messages. Only an admin of the channel can perform this action. - [Retrieve dm channel](https://docs.whop.com/api-reference/dm-channels/retrieve-dm-channel.md): Retrieves the details of an existing DM channel. - [Update dm channel](https://docs.whop.com/api-reference/dm-channels/update-dm-channel.md): Update the settings of an existing DM channel, such as its display name. Only an admin of the channel can perform this action. - [DM Member](https://docs.whop.com/api-reference/dm-members/dm-member.md): A user's membership record in a messaging channel, including notification preferences and read state. - [List dm members](https://docs.whop.com/api-reference/dm-members/list-dm-members.md): Returns a paginated list of members in a specific DM channel, sorted by the date they were added. - [Create dm member](https://docs.whop.com/api-reference/dm-members/create-dm-member.md): Add a new user to an existing DM channel. Only an admin of the channel can add members. - [Delete dm member](https://docs.whop.com/api-reference/dm-members/delete-dm-member.md): Remove a user from a DM channel. An admin can remove any member, and a member can remove themselves. - [Retrieve dm member](https://docs.whop.com/api-reference/dm-members/retrieve-dm-member.md): Retrieves the details of an existing DM member. - [Update dm member](https://docs.whop.com/api-reference/dm-members/update-dm-member.md): Update a DM channel member's settings, such as their notification preferences or membership status. - [Experience](https://docs.whop.com/api-reference/experiences/experience.md): An experience is a feature or content module within a product, such as a chat, course, or custom app. - [List experiences](https://docs.whop.com/api-reference/experiences/list-experiences.md): Returns a paginated list of experiences belonging to a company, with optional filtering by product and app. - [Create experience](https://docs.whop.com/api-reference/experiences/create-experience.md) - [Delete experience](https://docs.whop.com/api-reference/experiences/delete-experience.md) - [Retrieve experience](https://docs.whop.com/api-reference/experiences/retrieve-experience.md): Retrieves the details of an existing experience. - [Update experience](https://docs.whop.com/api-reference/experiences/update-experience.md) - [Attach experience](https://docs.whop.com/api-reference/experiences/attach-experience.md): Attach an experience to a product, making it accessible to the product's customers. - [Detach experience](https://docs.whop.com/api-reference/experiences/detach-experience.md): Detach an experience from a product, removing customer access to it through that product. - [Duplicate experience](https://docs.whop.com/api-reference/experiences/duplicate-experience.md): Duplicates an existing experience. The name will be copied, unless provided. The new experience will be attached to the same products as the original experience. If duplicating a Forum or Chat experience, the new experience will have the same settings as the… - [Forum Post](https://docs.whop.com/api-reference/forum-posts/forum-post.md): A post or comment in a forum feed, supporting rich text, attachments, polls, and reactions. - [List forum posts](https://docs.whop.com/api-reference/forum-posts/list-forum-posts.md): Returns a paginated list of forum posts within a specific experience, with optional filtering by parent post or pinned status. - [Create forum post](https://docs.whop.com/api-reference/forum-posts/create-forum-post.md): Create a new forum post or comment within an experience. Supports text content, attachments, polls, paywalling, and pinning. Pass experience_id 'public' with an account_id to post to an account's public forum. - [Retrieve forum post](https://docs.whop.com/api-reference/forum-posts/retrieve-forum-post.md): Retrieves the details of an existing forum post. - [Update forum post](https://docs.whop.com/api-reference/forum-posts/update-forum-post.md): Edit the content, attachments, pinned status, or visibility of an existing forum post or comment. - [Forum](https://docs.whop.com/api-reference/forums/forum.md): A discussion forum where members can create posts, comment, and react, belonging to an experience. - [List forums](https://docs.whop.com/api-reference/forums/list-forums.md): Returns a paginated list of forums within a specific company, with optional filtering by product. - [Retrieve forum](https://docs.whop.com/api-reference/forums/retrieve-forum.md): Retrieves the details of an existing forum. - [Update forum](https://docs.whop.com/api-reference/forums/update-forum.md): Update moderation and notification settings for a forum, such as who can post, who can comment, and email notification preferences. - [Message](https://docs.whop.com/api-reference/messages/message.md): A message sent within an experience chat, direct message, or group chat. - [List messages](https://docs.whop.com/api-reference/messages/list-messages.md): Returns a paginated list of messages within a specific experience chat, DM, or group chat channel, sorted by creation time. - [Create message](https://docs.whop.com/api-reference/messages/create-message.md): Send a new message in an experience chat, DM, or group chat channel. Supports text content, attachments, polls, and replies. - [Delete message](https://docs.whop.com/api-reference/messages/delete-message.md): 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. - [Retrieve message](https://docs.whop.com/api-reference/messages/retrieve-message.md): Retrieves the details of an existing message. - [Update message](https://docs.whop.com/api-reference/messages/update-message.md): Edit the content, attachments, or pinned status of an existing message in an experience chat, DM, or group chat channel. - [Chat Message Created](https://docs.whop.com/api-reference/messages/chat-message-created.md): Sent when a chat event is created - [Send Notification](https://docs.whop.com/api-reference/notifications/send-notification.md): 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. - [Reaction](https://docs.whop.com/api-reference/reactions/reaction.md): A single reaction left by a user on a feed post, such as a like or emoji. - [List reactions](https://docs.whop.com/api-reference/reactions/list-reactions.md): Returns a paginated list of emoji reactions on a specific message or forum post, sorted by most recent. - [Create reaction](https://docs.whop.com/api-reference/reactions/create-reaction.md): Add an emoji reaction or poll vote to a message or forum post. In forums, the reaction is always a like. - [Delete reaction](https://docs.whop.com/api-reference/reactions/delete-reaction.md): Remove an emoji reaction from a message or forum post. Only the reaction author or a channel admin can remove a reaction. - [Retrieve reaction](https://docs.whop.com/api-reference/reactions/retrieve-reaction.md): Retrieves the details of an existing reaction. - [Chat Reaction Created](https://docs.whop.com/api-reference/reactions/chat-reaction-created.md): Sent when a chat event is created - [Support Channel](https://docs.whop.com/api-reference/support-channels/support-channel.md): A messaging channel that can be a one-on-one DM, group chat, company support conversation, or platform-level direct message. - [List support channels](https://docs.whop.com/api-reference/support-channels/list-support-channels.md): Returns a paginated list of support channels for a specific company, with optional filtering by resolution status and custom sorting. - [Create support channel](https://docs.whop.com/api-reference/support-channels/create-support-channel.md): Open a new support channel between a company team member and a customer. Returns the existing channel if one already exists for that user. - [Retrieve support channel](https://docs.whop.com/api-reference/support-channels/retrieve-support-channel.md): Retrieves the details of an existing support channel. ## Courses Build learning experiences: courses, chapters, lessons, students, and lesson interactions. - [Course Chapter](https://docs.whop.com/api-reference/course-chapters/course-chapter.md): A grouping of related lessons within a course, used to organize content into sections. - [List course chapters](https://docs.whop.com/api-reference/course-chapters/list-course-chapters.md): Returns a paginated list of chapters within a course, ordered by position. - [Create course chapter](https://docs.whop.com/api-reference/course-chapters/create-course-chapter.md): Create a new chapter within a course to organize lessons into sections. - [Delete course chapter](https://docs.whop.com/api-reference/course-chapters/delete-course-chapter.md): Permanently delete a chapter and all of its lessons from a course. - [Retrieve course chapter](https://docs.whop.com/api-reference/course-chapters/retrieve-course-chapter.md): Retrieves the details of an existing course chapter. - [Update course chapter](https://docs.whop.com/api-reference/course-chapters/update-course-chapter.md): Update a chapter's title within a course. - [Course Lesson Interaction](https://docs.whop.com/api-reference/course-lesson-interactions/course-lesson-interaction.md): A record of a user's progress on a specific lesson, tracking whether they have completed it. - [List course lesson interactions](https://docs.whop.com/api-reference/course-lesson-interactions/list-course-lesson-interactions.md): Returns a paginated list of lesson interactions, filtered by lesson, course, user, or completion status. - [Retrieve course lesson interaction](https://docs.whop.com/api-reference/course-lesson-interactions/retrieve-course-lesson-interaction.md): Retrieves the details of an existing course lesson interaction. - [CourseLessonInteraction Completed](https://docs.whop.com/api-reference/course-lesson-interactions/courselessoninteraction-completed.md): Sent when a course lesson interaction is completed - [Course Lesson](https://docs.whop.com/api-reference/course-lessons/course-lesson.md): An individual learning unit within a chapter, which can contain text, video, PDF, or assessment content. - [List course lessons](https://docs.whop.com/api-reference/course-lessons/list-course-lessons.md): Returns a paginated list of lessons within a course or chapter, ordered by position. - [Create course lesson](https://docs.whop.com/api-reference/course-lessons/create-course-lesson.md): Create a new lesson within a course chapter. Lessons can contain video, text, or assessment content. - [Delete course lesson](https://docs.whop.com/api-reference/course-lessons/delete-course-lesson.md): Permanently delete a lesson and remove it from its chapter. - [Retrieve course lesson](https://docs.whop.com/api-reference/course-lessons/retrieve-course-lesson.md): Retrieves the details of an existing course lesson. - [Update course lesson](https://docs.whop.com/api-reference/course-lessons/update-course-lesson.md): Update a lesson's content, type, visibility, assessment questions, or media attachments. - [Mark as completed course lesson](https://docs.whop.com/api-reference/course-lessons/mark-as-completed-course-lesson.md): Mark a lesson as completed for the current user after they finish the content. - [Start course lesson](https://docs.whop.com/api-reference/course-lessons/start-course-lesson.md): Record that the current user has started viewing a lesson, creating progress tracking records. - [Submit assessment course lesson](https://docs.whop.com/api-reference/course-lessons/submit-assessment-course-lesson.md): Submit answers for a quiz or knowledge check lesson and receive a graded result. - [Course Student](https://docs.whop.com/api-reference/course-students/course-student.md): An enrollment record for a student in a course, including progress and completion metrics. - [List course students](https://docs.whop.com/api-reference/course-students/list-course-students.md): Returns a paginated list of students enrolled in a course, with optional name filtering. - [Retrieve course student](https://docs.whop.com/api-reference/course-students/retrieve-course-student.md): Retrieves the details of an existing course student. - [Course](https://docs.whop.com/api-reference/courses/course.md): A structured learning module containing chapters and lessons, belonging to an experience. - [List courses](https://docs.whop.com/api-reference/courses/list-courses.md): Returns a paginated list of courses, filtered by either an experience or a company. - [Create course](https://docs.whop.com/api-reference/courses/create-course.md): Create a new course within an experience, with optional chapters, lessons, and a certificate. - [Delete course](https://docs.whop.com/api-reference/courses/delete-course.md): Permanently delete a course and all of its chapters, lessons, and student progress. - [Retrieve course](https://docs.whop.com/api-reference/courses/retrieve-course.md): Retrieves the details of an existing course. - [Update course](https://docs.whop.com/api-reference/courses/update-course.md): Update a course's title, description, visibility, thumbnail, or chapter ordering. ## Identity & accounts Accounts, users, authorized team members, and connected social accounts. - [Authorized User](https://docs.whop.com/api-reference/authorized-users/authorized-user.md): A user who belongs to a company's team with access determined by their assigned role. - [List authorized users](https://docs.whop.com/api-reference/authorized-users/list-authorized-users.md): Returns a paginated list of authorized team members for a company, with optional filtering by user, role, and creation date. - [Create authorized user](https://docs.whop.com/api-reference/authorized-users/create-authorized-user.md): Add a new authorized user to a company. - [Delete authorized user](https://docs.whop.com/api-reference/authorized-users/delete-authorized-user.md): Remove an authorized user from a company. - [Retrieve authorized user](https://docs.whop.com/api-reference/authorized-users/retrieve-authorized-user.md): Retrieves the details of an existing authorized user. - [Fee Markup](https://docs.whop.com/api-reference/fee-markups/fee-markup.md): A fee markup configuration that defines additional charges applied to transactions for a platform's connected accounts. - [List fee markups](https://docs.whop.com/api-reference/fee-markups/list-fee-markups.md): Returns a paginated list of fee markups configured for a company. If the company is a platform account, returns the platform default markups. - [Create fee markup](https://docs.whop.com/api-reference/fee-markups/create-fee-markup.md): Create or update a fee markup for a company. If a markup for the specified fee type already exists, it will be updated with the new values. - [Delete fee markup](https://docs.whop.com/api-reference/fee-markups/delete-fee-markup.md): Delete a fee markup configuration for a company. This removes the custom fee override and reverts to the parent company's default fees. - [Users](https://docs.whop.com/api-reference/users/user.md): The Users API is documented in the Whop API reference. ## AI & MCP Connect AI agents to Whop over MCP, work with AI chats, and generate AI media (videos and images). - [AI Tools](https://docs.whop.com/developer/ai/overview.md): MCP servers, an installable skill, an LLM page index, and raw Markdown for every page: what Whop gives a coding agent. - [AI and MCP](https://docs.whop.com/developer/guides/ai_and_mcp.md): Per-client setup for both Whop MCP servers, browser sign-in, confirmation and idempotency, plus the LLM page index and raw Markdown for agents with no MCP client. - [Build with the CLI and Claude](https://docs.whop.com/developer/guides/cli-with-claude.md): Use the Whop CLI together with Claude to scaffold, build, and ship a Whop app from your terminal. - [Blueprints](https://docs.whop.com/developer/guides/blueprints.md): Start from a working Whop business. Browse the blueprint gallery, deploy one in a step, or clone its code and hand it to your AI assistant. - [Claude Code](https://docs.whop.com/developer/guides/plugins/claude-code.md): Install the Whop plugin for Claude Code to run your business from the terminal — products, checkout, payments, payouts, ads, and stats. - [Grok](https://docs.whop.com/developer/guides/plugins/grok.md): Install the Whop plugin for Grok Build to run your business from the terminal — products, checkout, payments, payouts, ads, and stats. - [AI Chat](https://docs.whop.com/api-reference/ai-chats/ai-chat.md): An AI-powered chat conversation belonging to a user, with optional scheduled automation. - [List ai chats](https://docs.whop.com/api-reference/ai-chats/list-ai-chats.md): Returns a paginated list of AI chat threads for the current authenticated user. - [Create ai chat](https://docs.whop.com/api-reference/ai-chats/create-ai-chat.md): Create a new AI chat thread and send the first message to the AI agent. - [Delete ai chat](https://docs.whop.com/api-reference/ai-chats/delete-ai-chat.md): Delete an AI chat thread so it no longer appears in the user's chat list. - [Retrieve ai chat](https://docs.whop.com/api-reference/ai-chats/retrieve-ai-chat.md): Retrieves the details of an existing AI chat. - [Update ai chat](https://docs.whop.com/api-reference/ai-chats/update-ai-chat.md): Update an AI chat's title, notification preferences, or associated account context. ## Apps & developer tools Build Whop apps and embed them: app views, permissions, OAuth, iframe, app builds, files, access tokens, and webhooks. - [Whop Apps](https://docs.whop.com/developer/apps/overview.md): Ship an app that thousands of Whop businesses can install from the App Store. - [Permissions](https://docs.whop.com/developer/guides/permissions.md): Configure the permissions your app needs and request approval from the creators who install it. - [App Views](https://docs.whop.com/developer/guides/app-views.md): Configure how and where your app appears on Whop - [Frosted UI](https://docs.whop.com/developer/guides/frosted_ui.md): Use Whop's UI kit and Tailwind design system. - [Authentication](https://docs.whop.com/developer/guides/authentication.md): Verify the current user and check their access level inside your Whop app. - [OAuth](https://docs.whop.com/developer/guides/oauth.md): Add "Sign in with Whop" to your site with OAuth 2.1 and Proof Key for Code Exchange (PKCE). - [React Native](https://docs.whop.com/developer/guides/react-native.md): Build cross-platform mobile and web apps for Whop using React Native. - [Development Proxy](https://docs.whop.com/developer/guides/dev-proxy.md): Run the Whop development proxy to replicate production authentication and iframe behavior during development. - [Iframe SDK](https://docs.whop.com/developer/guides/iframe.md): Interact with the whop website from within your app. - [Chat](https://docs.whop.com/developer/guides/chat.md): Send messages, manage channels, and react to events in any Whop community. - [Forums](https://docs.whop.com/developer/guides/forums.md): Create forum posts, fetch threads, and add comments or reactions inside any Whop community. - [Push Notifications](https://docs.whop.com/developer/guides/notifications.md): Send push notifications to users in your app, scoped by experience or account. - [Affiliates](https://docs.whop.com/developer/guides/affiliates.md): Create affiliate records, assign per-plan or rev-share commission overrides, and track referral earnings. - [Memberships](https://docs.whop.com/developer/guides/memberships.md): Manage subscription lifecycle. Pause, resume, cancel, restore, and add free days. - [Upload Files](https://docs.whop.com/developer/guides/upload-files.md): Upload images and files for use across the Whop platform - [Upload Files Directly](https://docs.whop.com/developer/guides/direct-file-uploads.md): Upload files to Whop storage with presigned single-part and multipart uploads - [Example Integration](https://docs.whop.com/developer/guides/example-integration.md): Build a marketplace on top of Whop's global payment and payout rails. - [Websites](https://docs.whop.com/developer/websites/overview.md): Ship a fully hosted website on Whop — served at your own whop.site address, versioned on every deploy, and wired to payments and analytics. - [Build a Website with the CLI](https://docs.whop.com/developer/websites/quickstart.md): Scaffold a Vite app, run it locally against real Whop data, and deploy it to your own whop.site address. - [Blueprints](https://docs.whop.com/developer/websites/blueprints.md): Deploy a working Whop business — products, pricing, and a live website — in one step, or clone its code with the CLI. - [Hosting](https://docs.whop.com/developer/websites/hosting.md): What Whop runs when someone visits your site: builds and rollbacks, app secrets, automatic API authentication, and server logs. - [Track Visitors](https://docs.whop.com/developer/websites/tracking.md): Every site on whop.site ships the Whop pixel already installed. Page views and checkout events are automatic; add whop.track calls for the funnel steps Whop can't see. - [Access Token](https://docs.whop.com/api-reference/access-tokens/access-token.md): A short-lived access token used to authenticate API requests on behalf of a user. - [Create access token](https://docs.whop.com/api-reference/access-tokens/create-access-token.md): Create a short-lived access token for authenticating API requests. When using API key authentication, provide account_id or user_id. When using OAuth, the user is derived from the token. Use this token with Whop's web and mobile embedded components. - [Account Link](https://docs.whop.com/api-reference/account-links/account-link.md): A temporary, time-limited URL that grants a user access to an external account management page. - [Create account link](https://docs.whop.com/api-reference/account-links/create-account-link.md): Generate a URL that directs a sub-merchant to their account portal, such as the hosted payouts dashboard or the KYC onboarding flow. - [App Build](https://docs.whop.com/api-reference/app-builds/app-build.md): A versioned build artifact for a Whop React Native App, submitted for review and deployment to a specific platform. - [List App Builds](https://docs.whop.com/api-reference/app-builds/list-app-builds.md): Returns a paginated list of build artifacts for an app, newest first, with optional platform, status, and creation-date filters. - [Create App Build](https://docs.whop.com/api-reference/app-builds/create-app-build.md): Uploads a new build artifact for an app. Upload the file first (POST /files or a direct upload), then reference it here; iOS and Android take a .zip bundle, web takes a JavaScript file or a .zip archive of the hosted site. - [Retrieve App Build](https://docs.whop.com/api-reference/app-builds/retrieve-app-build.md): Retrieves the details of an existing app build. - [Promote App Build](https://docs.whop.com/api-reference/app-builds/promote-app-build.md): Promotes a draft or approved app build to production so it becomes the active version served to users. Draft builds enter review first. - [App](https://docs.whop.com/api-reference/apps/app.md): An app is an integration built on Whop. Apps can serve consumers as experiences within products, or serve companies as business tools. - [List Apps](https://docs.whop.com/api-reference/apps/list-apps.md): Lists apps on the Whop platform: the app store's live apps, or — with `account_id` and developer access to that account — every app the account owns. Requires authentication except for Whop's public app and website discovery lists. Public website discovery… - [Create App](https://docs.whop.com/api-reference/apps/create-app.md): Registers a new app on the Whop developer platform. Apps provide custom experiences that can be added to products. - [Retrieve App](https://docs.whop.com/api-reference/apps/retrieve-app.md): Retrieves an app by ID, claimed route, active verified custom hostname, or proxy domain id. Custom hostnames return 404 for inactive assignments, suspended accounts, or deleted apps. Credential fields (api_key, default_api_key, secrets) render `null` unless… - [Update App](https://docs.whop.com/api-reference/apps/update-app.md): Updates the settings, metadata, or status of an app. Fields that are omitted keep their current value. - [File](https://docs.whop.com/api-reference/files/file.md): A file that has been uploaded or is pending upload. - [Create File](https://docs.whop.com/api-reference/files/create-file.md): Creates a file and returns a presigned destination to upload its bytes to. PUT the bytes to `upload_url` (single-part), or to each of `multipart_upload_urls` and then call Complete File Multipart Upload. Once the bytes land the file becomes `ready`, and its… - [Retrieve File](https://docs.whop.com/api-reference/files/retrieve-file.md): Retrieves a file you uploaded — poll it after uploading the bytes to see `upload_status` become `ready`. Only the creator can retrieve a file this way; a file attached to another resource is read through that resource. - [Webhook](https://docs.whop.com/api-reference/webhooks/webhook.md): A webhook endpoint that receives event notifications for a company via HTTP POST. - [List Webhooks](https://docs.whop.com/api-reference/webhooks/list-webhooks.md): Returns a paginated list of webhook endpoints configured for an account, ordered by most recently created. - [Create Webhook](https://docs.whop.com/api-reference/webhooks/create-webhook.md): Creates a webhook endpoint that receives event notifications via HTTP POST. - [Delete Webhook](https://docs.whop.com/api-reference/webhooks/delete-webhook.md): Permanently deletes a webhook endpoint. Returns `true` on success, matching the legacy proxy response. - [Retrieve Webhook](https://docs.whop.com/api-reference/webhooks/retrieve-webhook.md): Retrieves the details of an existing webhook. - [Update Webhook](https://docs.whop.com/api-reference/webhooks/update-webhook.md): Updates a webhook endpoint's URL, subscribed events, pinned payload version, or enabled state. - [Send Test Event](https://docs.whop.com/api-reference/webhooks/send-test-event.md): Sends a sample payload for the given event to the webhook's URL and returns the delivery result. ## Stats & reporting Query financial and engagement stats: schemas, metrics, and time series. - [Describe stats](https://docs.whop.com/api-reference/stats/describe-stats.md): Describe available stats schema. Without resource returns root nodes and metrics. With resource returns node columns, associations, and available metrics. - [Metric stats](https://docs.whop.com/api-reference/stats/metric-stats.md): Query an aggregated metric. Returns data grouped by period with optional breakdowns. - [Raw stats](https://docs.whop.com/api-reference/stats/raw-stats.md): Query raw data from a resource. Returns paginated rows with all columns. ## Bounties Create and manage bounties. - [Bounties](https://docs.whop.com/developer/bounties/overview.md): Post paid tasks with an escrowed reward, collect submitted work from workers, and pay out on approval. - [Run a Bounty Program](https://docs.whop.com/developer/bounties/run-a-bounty-program.md): Post bounties on behalf of an account, fund the escrow, and surface the submission queue in your own product: rewards, the $5 escrow floor, `experience_id`, and review. - [Workforce Bounty](https://docs.whop.com/api-reference/bounties/workforce-bounty.md): A privately accessible bounty. - [List Bounties](https://docs.whop.com/api-reference/bounties/list-bounties.md): Lists bounties visible to the credential — for an account API key, the account's bounties including scheduled drafts; for a user token, the bounties the user can see and work. - [Create Bounty](https://docs.whop.com/api-reference/bounties/create-bounty.md): Creates a bounty and escrows its reward pool. Publishes immediately, or as a scheduled draft when you set `publish_at`. - [Retrieve Bounty](https://docs.whop.com/api-reference/bounties/retrieve-bounty.md): Retrieves a bounty by ID. Authentication is optional: a request with no credential reads the bounty when it is publicly visible — published or completed, and not restricted to a private experience's members. Bounties outside the caller's scope, and bounties… ## SDKs & embedded elements Embed Whop UI: the checkout embed, the WhopElements entry point, and payouts, chat, and wallet elements, with shared types and styling. - [Getting Started with Elements](https://docs.whop.com/elements/beta/getting-started.md): Install Whop Elements and mount your first element in React, JavaScript, Swift, or React Native. - [Appearance](https://docs.whop.com/elements/beta/appearance.md): Theme, tokens, and per-part styling for every element. - [Payments](https://docs.whop.com/elements/beta/payments/overview.md): Collect a payment from a `plan_` ID or inline currency and amount. Mount PaymentElement, CardElement, or CardFields, then call `payments.createConfirmationToken` with billing details. Wallet selections open their sheet automatically. Confirm the token… - [PaymentElement](https://docs.whop.com/elements/beta/payments/payment.md): Shows available payment methods and collects the selected method's required fields and disclosures. Use `change` to enable your pay button. In its activation handler, call `payments.createConfirmationToken()`. Confirm the token server-side, then pass any… - [AddressElement](https://docs.whop.com/elements/beta/payments/address.md): Collects a billing or shipping address. Fields, order, and validation follow the selected country. Includes street autocomplete and methods to read or validate the address. - [CardElement](https://docs.whop.com/elements/beta/payments/card.md): Prearranged fields for card number, expiration, and security code. Create with `payments.create(\"card\")`, enable your payment button from `onChange`, and confirm with `payments.createConfirmationToken()`. Card numbers remain in PCI-isolated hosted fields.… - [CardFields](https://docs.whop.com/elements/beta/payments/cardFields.md): Three separately mountable, PCI-isolated card fields for custom layouts: number, expiration, and security code. Create with `payments.create(\"cardFields\")`, place each field, enable your payment button from `onChange`, and confirm with… - [CardNumberElement](https://docs.whop.com/elements/beta/payments/cardFields-cardNumber.md): PCI-isolated hosted card number field. Card numbers never reach the host page. - [CardExpiryElement](https://docs.whop.com/elements/beta/payments/cardFields-cardExpiry.md): PCI-isolated hosted card expiration field. - [CardCvcElement](https://docs.whop.com/elements/beta/payments/cardFields-cardCvc.md): PCI-isolated hosted card security code field. - [EmailElement](https://docs.whop.com/elements/beta/payments/email.md): Collects the buyer's email and passes it to `payments.createConfirmationToken()` while mounted. Explicit `billingDetails.email` wins. A matching Whop account shows optional sign-in with code verification. Successful sign-in unlocks saved payment methods in… - [TaxIdElement](https://docs.whop.com/elements/beta/payments/taxId.md): Collects a business tax registration accepted by the API. Labels use buyer-facing names. The placeholder matches the selected format. `country` preselects a type. `onChange` emits committed pairs. The host supplies API validation errors. - [BrandingElement](https://docs.whop.com/elements/beta/payments/branding.md): Whop's merchant-of-record notice: the Whop wordmark with links to the buyer terms and privacy policy. Mount it alongside every payment collection surface. - [PaymentRequest](https://docs.whop.com/elements/beta/payments/paymentRequest.md): Low-level Apple Pay or Google Pay sheet for custom buttons, express checkout, and shipping callbacks. Wallet tiles automate this flow through `payments.createConfirmationToken`. Await `canMakePayment()` to check availability and prime the sheet, then call… - [Verifications](https://docs.whop.com/elements/beta/verifications/overview.md): Collects and verifies identity information for an account. Mount `kyc` for a complete KYC or KYB flow backed by the Verifications API. - [KycElement](https://docs.whop.com/elements/beta/verifications/kyc.md): A complete identity-verification flow. It collects individual KYC or business KYB details, starts or resumes the hosted provider session, handles follow-up information and document requests, polls status, and renders the final result without requiring the… - [CapabilitiesElement](https://docs.whop.com/elements/beta/verifications/capabilities.md): The account's verification standing: whether individual and business verification are done, and which capabilities that unlocks. Read-only — pressing a verify button reports `verificationRequested` and stays put, so the host mounts its own flow, such as this… - [RfiElement](https://docs.whop.com/elements/beta/verifications/rfi.md): Everything the account still owes compliance, and the forms to answer it. Each row is one group of requirements — grouped by the system that asked, because each relays to its provider once its own items are answered — and pressing it opens that group’s form… - [Checkout](https://docs.whop.com/elements/beta/checkout/overview.md): Drives a full hosted checkout for one plan — price summary, promo codes, the currency the buyer pays in, and the whole payment collection surface (the payments elements, composed inside) — against the Whop checkout sessions API. Mount it with a `plan` (or a… - [CheckoutElement](https://docs.whop.com/elements/beta/checkout/checkout.md): The full checkout surface — order summary with the live quote, promo code entry, the currency the buyer pays in, everything this checkout has to collect from the buyer, the composed payment methods surface, and the pay flow. What it collects is whatever the… - [ExpressCheckoutElement](https://docs.whop.com/elements/beta/checkout/expressCheckout.md): One-press Apple Pay and Google Pay buttons for a checkout — the OS payment sheet collects whatever the session still needs (the buyer's email, a shipping address for physical goods, and in Apple Pay a promo code where the seller offers entry) and one press… - [Ads](https://docs.whop.com/elements/beta/ads/overview.md): An advertising account. Scope it to a Whop account with `accountId` — the ad account underneath is assigned server-side and never surfaces here — then mount `reporting` for what the account spent and what came back, or `campaign-creator` to build a campaign. - [Reporting](https://docs.whop.com/elements/beta/ads/reporting.md): An advertising account's reporting: what it spent and what came back, over a window, at whatever level you narrow to. Mount `chart`, `table`, or both — they read the same window, the same credit rule, and the same selection, so two surfaces side by side can… - [ChartElement](https://docs.whop.com/elements/beta/ads/reporting-chart.md): An account’s performance over a window, with a picker for what to plot — spend, impressions, clicks, or any conversion the account records. Read-only. - [TableElement](https://docs.whop.com/elements/beta/ads/reporting-table.md): An advertising account's campaigns, ad groups, and ads in one table, with the tabs that move between them: pick rows to narrow the level below, search, sort, break the numbers down, choose your columns, and pause, resume, duplicate, or delete straight from a… - [BillingSetupElement](https://docs.whop.com/elements/beta/ads/billing-setup.md): Which payment methods ad spend bills against: a primary used first, and an optional backup for when it fails. Both are chosen from the methods already saved on the account, and picking one saves it immediately — there is no separate submit. Adding a card… - [CampaignCreatorElement](https://docs.whop.com/elements/beta/ads/campaign-creator.md): The advertising campaign builder: objective and budget, ad groups with their targeting and schedule, and the ads themselves with their creative — the whole flow through to launch. Opens empty to build a new campaign, or on an existing one when you pass… - [Tracking](https://docs.whop.com/elements/beta/tracking/overview.md): An account's tracked audience: everyone its pixel has seen, and every event they performed. Scope it to an account with `accountId`, then mount `people`, `events`, or both. They read the same window and the same credit rule, so two surfaces side by side can… - [PeopleElement](https://docs.whop.com/elements/beta/tracking/people.md): Everyone the account has seen — visitors and customers resolved from pixel activity, with their source, spend, and activity counters. Search, filter by source, event, geography, or device, sort any column, and page through. A row click follows `links.person`… - [EventsElement](https://docs.whop.com/elements/beta/tracking/events.md): Every event the account measured — page views, leads, purchases, and custom pixel events — as a raw, filterable stream. The rows behind any metric: filter by event, source, geography, or device over the handle’s window, or search one person’s identifier to… - [PersonElement](https://docs.whop.com/elements/beta/tracking/person.md): Everything the account knows about one person: who they are, where they came from, what they have spent, and every event they have performed, in order. The view a person click leads to: mount it on the page `links.person` points at, or present it over your… - [Wallet](https://docs.whop.com/elements/beta/wallet/overview.md): Drives an account's money surfaces. `required-actions` is the outstanding-action bar from Whop's balance dashboard. `actions` renders the Deposit, Accept, Send, and Convert controls: Deposit, Send, and Convert open their Wallet overlays, while Accept opens… - [RequiredActionsElement](https://docs.whop.com/elements/beta/wallet/required-actions.md): The outstanding-action banners from Whop's balance dashboard — identity verification, deposits, tax, and the rest — in the same order the API returns them. An account with nothing outstanding renders nothing at all, so the element can sit permanently in a… - [ActionsElement](https://docs.whop.com/elements/beta/wallet/actions.md): The account action row from Whop's balance dashboard. Deposit, Send, Withdraw, and Convert open the Wallet controller's built-in overlays. Accept opens Whop's checkout-link creator for a business account or company creation for a personal account. Each… - [Balances](https://docs.whop.com/elements/beta/wallet/balances.md): Three views of an account's money. The balance view shows the total, a chart of how it changed, and a picker for the time range. The list view shows the holdings that make up that total, valued in dollars. The breakdown view splits one currency into… - [BalanceElement](https://docs.whop.com/elements/beta/wallet/balances-balance.md): An account's balance and a chart of how it changed. The total and its change sit at the top, the chart below that, and the time range buttons at the bottom. The viewer can read individual points on the chart and switch the time range themselves. - [BreakdownElement](https://docs.whop.com/elements/beta/wallet/balances-breakdown.md): One currency's total split into available, pending, reserve, and negative balances. Zero-value rows disappear, and the surface deliberately contains no money-movement buttons so the host owns those actions. - [SettlementElement](https://docs.whop.com/elements/beta/wallet/balances-settlement.md): The account balance details shown by Whop's dashboard: available funds, pending settlement dates, reserve terms, and any negative balance. It opens as a 550px modal and uses the balances handle's account, currency, and credential. - [ListElement](https://docs.whop.com/elements/beta/wallet/balances-list.md): The holdings behind an account's balance. Every currency and token gets its own row, showing its name and its value in dollars, largest first. Rows can report which one the viewer tapped, so you can open your own screen for it. When `openHoldingOnSelect` is… - [ActivityElement](https://docs.whop.com/elements/beta/wallet/activity.md): An account's ledger activity: every movement of money in or out, newest first. The list pages as the viewer scrolls, and rows report which one was tapped instead of navigating, so you can open your own detail screen. - [ActivityDetailElement](https://docs.whop.com/elements/beta/wallet/activityDetail.md): A standalone detail drawer for one movement. Point it at a prefetched financial-activity row, a ledger activity ID, or a card transaction ID — a prefetched row takes precedence, otherwise the element retrieves the record itself. A card transaction opens the… - [DepositElement](https://docs.whop.com/elements/beta/wallet/deposit.md): Funds a Whop account. Renders an amount field and the account's live funding rails — crypto (a per-network deposit address with its QR) and bank transfer (the wire fields for each settlement currency). A business account's rails resolve with no credentials,… - [ConvertElement](https://docs.whop.com/elements/beta/wallet/convert.md): Converts an account's USD balance to Gold or Coinbase Wrapped Bitcoin, and back, through Whop's public swaps API. A cross-origin mount needs an `accessToken` scoped to `company:balance:read` plus `crypto_wallet:swap` or `crypto_wallet:manage`. - [WithdrawElement](https://docs.whop.com/elements/beta/wallet/withdraw.md): Collects a payout amount and saved payout method, groups standard and instant delivery choices with live fees and arrival estimates, and collects a new payout method when needed. When the host does not drive the flow, the element lists methods and creates… - [SendElement](https://docs.whop.com/elements/beta/wallet/send.md): Sends money from an account to a recipient — a user, another account, or a public claim link anyone can redeem. Direct transfers use the source account's configured fiat or crypto rail. Renders its own recipient search resolved from the account ID with no… - [CardDetailsElement](https://docs.whop.com/elements/beta/wallet/cardDetails.md): One card and what has been spent on it: the card itself, what it has spent against its limit, and its latest transactions. Opens as a drawer. The card face, its reveal and its lock come from the `whopCard` element composed inside, so a host gets one surface… - [Cards](https://docs.whop.com/elements/beta/wallet/cards.md): An account's card surfaces, mounted from one place: the compact issued-card list, the full sortable roster, the spend chart, and a single revealable card. Mount the faces the page needs — they share the account and the credential this unit is minted with, so… - [CardsElement](https://docs.whop.com/elements/beta/wallet/cards-cards.md): Lists the account's active issued cards, most recently issued first. Needs an `accessToken`. The title and rows are click targets that emit events instead of navigating — a host wires up its own routing and card-detail UI. - [CardsTableElement](https://docs.whop.com/elements/beta/wallet/cards-cardsTable.md): A sortable table of every issued card on an account, including cardholder, last month's spend, limit, and creation date. Rows and the create button emit events so the host owns card details and issuance flows. - [CardsChartElement](https://docs.whop.com/elements/beta/wallet/cards-cardsChart.md): A business account's card spend over time, using the same interactive bar chart as Whop's cards dashboard. The period picker changes the mounted chart and emits an event so the host can persist the selection. - [WhopCardElement](https://docs.whop.com/elements/beta/wallet/cards-whopCard.md): Renders one issued Whop Card. The element prefetches authorized secrets immediately after it mounts with a card ID, but keeps them masked until the viewer clicks it or selects `View details`. The API remains the permission authority. Includes lock and unlock… - [CardTransactionsElement](https://docs.whop.com/elements/beta/wallet/cards-cardTransactions.md): Every card transaction on an account, as the sortable table the dashboard shows: date, merchant, amount, cashback, status, card and cardholder, with filters for status, card and cardholder. A host can seed any of those three so the table opens on a narrowed… - [VerificationElement](https://docs.whop.com/elements/beta/wallet/verification.md): A banner asking the account holder to verify their identity, shown only while verification is outstanding — an account that has already verified renders nothing at all, so the element can sit permanently in a layout. The headline and body come from the API,… - [Websites](https://docs.whop.com/elements/beta/websites/overview.md): An account's websites: every site built on whop.site plus every domain the Whop Pixel reports, with traffic and attributed revenue per domain. Mount `websites` and it lists them with visitors, page views, sales, revenue, trend, and most-viewed pages. Mount… - [WebsitesElement](https://docs.whop.com/elements/beta/websites/websites.md): An account's websites in one table: every site built on whop.site — listed from the moment it exists, zeros until traffic arrives — merged by hostname with every domain the Whop Pixel reports. Rows for the whop.site ones carry a Whop mark, so the two sources… - [PixelSetupElement](https://docs.whop.com/elements/beta/websites/pixel-setup.md): Installs the Whop Pixel and wires conversion events: copy the snippet, check a page for it, confirm the events fire. Mount it inline, or inside your own overlay. - [Getting Started with Elements](https://docs.whop.com/elements/upcoming/getting-started.md): Install Whop Elements and mount your first element in React, JavaScript, Swift, or React Native. - [Appearance](https://docs.whop.com/elements/upcoming/appearance.md): Theme, tokens, and per-part styling for every element. - [Payments](https://docs.whop.com/elements/upcoming/payments/overview.md): Browse account payments with PaymentsElement, or collect a payment from a `plan_` ID or inline currency and amount. Mount PaymentElement, CardElement, or CardFields, then call `payments.createConfirmationToken` with billing details. Wallet selections open… - [PaymentsElement](https://docs.whop.com/elements/upcoming/payments/payments.md): The dashboard payments table with status cards, search, filters, sorting, row selection, CSV export, column settings, and pagination. Reads all payment pages to compute complete counts and filter locally; intended for accounts with modest payment histories.… - [PaymentElement](https://docs.whop.com/elements/upcoming/payments/payment.md): Shows available payment methods and collects the selected method's required fields and disclosures. Use `change` to enable your pay button. In its activation handler, call `payments.createConfirmationToken()`. Confirm the token server-side, then pass any… - [AddressElement](https://docs.whop.com/elements/upcoming/payments/address.md): Collects a billing or shipping address. Fields, order, and validation follow the selected country. Includes street autocomplete and methods to read or validate the address. - [CardElement](https://docs.whop.com/elements/upcoming/payments/card.md): Prearranged fields for card number, expiration, and security code. Create with `payments.create(\"card\")`, enable your payment button from `onChange`, and confirm with `payments.createConfirmationToken()`. Card numbers remain in PCI-isolated hosted fields.… - [CardFields](https://docs.whop.com/elements/upcoming/payments/cardFields.md): Three separately mountable, PCI-isolated card fields for custom layouts: number, expiration, and security code. Create with `payments.create(\"cardFields\")`, place each field, enable your payment button from `onChange`, and confirm with… - [CardNumberElement](https://docs.whop.com/elements/upcoming/payments/cardFields-cardNumber.md): PCI-isolated hosted card number field. Card numbers never reach the host page. - [CardExpiryElement](https://docs.whop.com/elements/upcoming/payments/cardFields-cardExpiry.md): PCI-isolated hosted card expiration field. - [CardCvcElement](https://docs.whop.com/elements/upcoming/payments/cardFields-cardCvc.md): PCI-isolated hosted card security code field. - [EmailElement](https://docs.whop.com/elements/upcoming/payments/email.md): Collects the buyer's email and passes it to `payments.createConfirmationToken()` while mounted. Explicit `billingDetails.email` wins. A matching Whop account shows optional sign-in with code verification. Successful sign-in unlocks saved payment methods in… - [TaxIdElement](https://docs.whop.com/elements/upcoming/payments/taxId.md): Collects a business tax registration accepted by the API. Labels use buyer-facing names. The placeholder matches the selected format. `country` preselects a type. `onChange` emits committed pairs. The host supplies API validation errors. - [BrandingElement](https://docs.whop.com/elements/upcoming/payments/branding.md): Whop's merchant-of-record notice: the Whop wordmark with links to the buyer terms and privacy policy. Mount it alongside every payment collection surface. - [PaymentRequest](https://docs.whop.com/elements/upcoming/payments/paymentRequest.md): Low-level Apple Pay or Google Pay sheet for custom buttons, express checkout, and shipping callbacks. Wallet tiles automate this flow through `payments.createConfirmationToken`. Await `canMakePayment()` to check availability and prime the sheet, then call… - [Verifications](https://docs.whop.com/elements/upcoming/verifications/overview.md): Collects and verifies identity information for an account. Mount `kyc` for a complete KYC or KYB flow backed by the Verifications API. - [KycElement](https://docs.whop.com/elements/upcoming/verifications/kyc.md): A complete identity-verification flow. It collects individual KYC or business KYB details, starts or resumes the hosted provider session, handles follow-up information and document requests, polls status, and renders the final result without requiring the… - [CapabilitiesElement](https://docs.whop.com/elements/upcoming/verifications/capabilities.md): The account's verification standing: whether individual and business verification are done, and which capabilities that unlocks. Read-only — pressing a verify button reports `verificationRequested` and stays put, so the host mounts its own flow, such as this… - [RfiElement](https://docs.whop.com/elements/upcoming/verifications/rfi.md): Everything the account still owes compliance, and the forms to answer it. Each row is one group of requirements — grouped by the system that asked, because each relays to its provider once its own items are answered — and pressing it opens that group’s form… - [Checkout](https://docs.whop.com/elements/upcoming/checkout/overview.md): Drives a full hosted checkout for one plan — price summary, promo codes, the currency the buyer pays in, and the whole payment collection surface (the payments elements, composed inside) — against the Whop checkout sessions API. Mount it with a `plan` (or a… - [CheckoutElement](https://docs.whop.com/elements/upcoming/checkout/checkout.md): The full checkout surface — order summary with the live quote, promo code entry, the currency the buyer pays in, everything this checkout has to collect from the buyer, the composed payment methods surface, and the pay flow. What it collects is whatever the… - [ExpressCheckoutElement](https://docs.whop.com/elements/upcoming/checkout/expressCheckout.md): One-press Apple Pay and Google Pay buttons for a checkout — the OS payment sheet collects whatever the session still needs (the buyer's email, a phone number where the seller collects one, a shipping address for physical goods, and in Apple Pay a promo code… - [Ads](https://docs.whop.com/elements/upcoming/ads/overview.md): An advertising account. Scope it to a Whop account with `accountId` — the ad account underneath is assigned server-side and never surfaces here — then mount `reporting` for what the account spent and what came back, or `campaign-creator` to build a campaign. - [Reporting](https://docs.whop.com/elements/upcoming/ads/reporting.md): An advertising account's reporting: what it spent and what came back, over a window, at whatever level you narrow to. Mount `chart`, `table`, or both — they read the same window, the same credit rule, and the same selection, so two surfaces side by side can… - [ChartElement](https://docs.whop.com/elements/upcoming/ads/reporting-chart.md): An account’s performance over a window, with a picker for what to plot — spend, impressions, clicks, or any conversion the account records. Read-only. - [TableElement](https://docs.whop.com/elements/upcoming/ads/reporting-table.md): An advertising account's campaigns, ad groups, and ads in one table, with the tabs that move between them: pick rows to narrow the level below, search, sort, break the numbers down, choose your columns, and pause, resume, duplicate, or delete straight from a… - [BillingSetupElement](https://docs.whop.com/elements/upcoming/ads/billing-setup.md): Which payment methods ad spend bills against: a primary used first, and an optional backup for when it fails. Both are chosen from the methods already saved on the account, and picking one saves it immediately — there is no separate submit. Adding a card… - [CampaignCreatorElement](https://docs.whop.com/elements/upcoming/ads/campaign-creator.md): The advertising campaign builder: objective and budget, ad groups with their targeting and schedule, and the ads themselves with their creative — the whole flow through to launch. Opens empty to build a new campaign, or on an existing one when you pass… - [Tracking](https://docs.whop.com/elements/upcoming/tracking/overview.md): An account's tracked audience: everyone its pixel has seen, and every event they performed. Scope it to an account with `accountId`, then mount `people`, `events`, or both. They read the same window and the same credit rule, so two surfaces side by side can… - [PeopleElement](https://docs.whop.com/elements/upcoming/tracking/people.md): Everyone the account has seen — visitors and customers resolved from pixel activity, with their source, spend, and activity counters. Search, filter by source, event, geography, or device, sort any column, and page through. A row click follows `links.person`… - [EventsElement](https://docs.whop.com/elements/upcoming/tracking/events.md): Every event the account measured — page views, leads, purchases, and custom pixel events — as a raw, filterable stream. The rows behind any metric: filter by event, source, geography, or device over the handle’s window, or search one person’s identifier to… - [PersonElement](https://docs.whop.com/elements/upcoming/tracking/person.md): Everything the account knows about one person: who they are, where they came from, what they have spent, and every event they have performed, in order. The view a person click leads to: mount it on the page `links.person` points at, or present it over your… - [Wallet](https://docs.whop.com/elements/upcoming/wallet/overview.md): Drives an account's money surfaces. `required-actions` is the outstanding-action bar from Whop's balance dashboard. `actions` renders the Deposit, Accept, Send, and Convert controls: Deposit, Send, and Convert open their Wallet overlays, while Accept opens… - [RequiredActionsElement](https://docs.whop.com/elements/upcoming/wallet/required-actions.md): The outstanding-action banners from Whop's balance dashboard — identity verification, deposits, tax, and the rest — in the same order the API returns them. An account with nothing outstanding renders nothing at all, so the element can sit permanently in a… - [ActionsElement](https://docs.whop.com/elements/upcoming/wallet/actions.md): The account action row from Whop's balance dashboard. Deposit, Send, Withdraw, and Convert open the Wallet controller's built-in overlays. Accept opens Whop's checkout-link creator for a business account or company creation for a personal account. Each… - [Balances](https://docs.whop.com/elements/upcoming/wallet/balances.md): Three views of an account's money. The balance view shows the total, a chart of how it changed, and a picker for the time range. The list view shows the holdings that make up that total, valued in dollars. The breakdown view splits one currency into… - [BalanceElement](https://docs.whop.com/elements/upcoming/wallet/balances-balance.md): An account's balance and a chart of how it changed. The total and its change sit at the top, the chart below that, and the time range buttons at the bottom. The viewer can read individual points on the chart and switch the time range themselves. - [BreakdownElement](https://docs.whop.com/elements/upcoming/wallet/balances-breakdown.md): One currency's total split into available, pending, reserve, and negative balances. Zero-value rows disappear, and the surface deliberately contains no money-movement buttons so the host owns those actions. - [SettlementElement](https://docs.whop.com/elements/upcoming/wallet/balances-settlement.md): The account balance details shown by Whop's dashboard: available funds, pending settlement dates, reserve terms, and any negative balance. It opens as a 550px modal and uses the balances handle's account, currency, and credential. - [ListElement](https://docs.whop.com/elements/upcoming/wallet/balances-list.md): The holdings behind an account's balance. Every currency and token gets its own row, showing its name and its value in dollars, largest first. Rows can report which one the viewer tapped, so you can open your own screen for it. When `openHoldingOnSelect` is… - [Reports](https://docs.whop.com/elements/upcoming/wallet/reports.md): Balance history and the financial activity behind it, including CSV exports. Account statements are available in the Whop dashboard. - [BalanceReportElement](https://docs.whop.com/elements/upcoming/wallet/reports-balanceReport.md): Balance history with date, timezone, and currency controls, starting and ending balances, and money-in and money-out breakdowns. Drill into activity and export it without leaving the element. - [ReportActivityElement](https://docs.whop.com/elements/upcoming/wallet/reports-reportActivity.md): Financial activity with date, currency, direction, and movement filters, pagination, and CSV export. Mount independently or open it from the balance report. - [ActivityElement](https://docs.whop.com/elements/upcoming/wallet/activity.md): An account's ledger activity: every movement of money in or out, newest first. The list pages as the viewer scrolls, and rows report which one was tapped instead of navigating, so you can open your own detail screen. - [ActivityDetailElement](https://docs.whop.com/elements/upcoming/wallet/activityDetail.md): A standalone detail drawer for one movement. Point it at a prefetched financial-activity row, a ledger activity ID, or a card transaction ID — a prefetched row takes precedence, otherwise the element retrieves the record itself. A card transaction opens the… - [DepositElement](https://docs.whop.com/elements/upcoming/wallet/deposit.md): Funds a Whop account. Renders an amount field and the account's live funding rails — crypto (a per-network deposit address with its QR) and bank transfer (the wire fields for each settlement currency). A business account's rails resolve with no credentials,… - [ConvertElement](https://docs.whop.com/elements/upcoming/wallet/convert.md): Converts an account's USD balance to Gold or Coinbase Wrapped Bitcoin, and back, through Whop's public swaps API. A cross-origin mount needs an `accessToken` scoped to `company:balance:read` plus `crypto_wallet:swap` or `crypto_wallet:manage`. - [WithdrawElement](https://docs.whop.com/elements/upcoming/wallet/withdraw.md): Collects a payout amount and saved payout method, groups standard and instant delivery choices with live fees and arrival estimates, and collects a new payout method when needed. When the host does not drive the flow, the element lists methods and creates… - [SendElement](https://docs.whop.com/elements/upcoming/wallet/send.md): Sends money from an account to a recipient — a user, another account, or a public claim link anyone can redeem. Direct transfers use the source account's configured fiat or crypto rail. Renders its own recipient search resolved from the account ID with no… - [CardDetailsElement](https://docs.whop.com/elements/upcoming/wallet/cardDetails.md): One card and what has been spent on it: the card itself, what it has spent against its limit, and its latest transactions. Opens as a drawer. The card face, its reveal and its lock come from the `whopCard` element composed inside, so a host gets one surface… - [Cards](https://docs.whop.com/elements/upcoming/wallet/cards.md): An account's card surfaces, mounted from one place: the compact issued-card list, the full sortable roster, the spend chart, and a single revealable card. Mount the faces the page needs — they share the account and the credential this unit is minted with, so… - [CardsElement](https://docs.whop.com/elements/upcoming/wallet/cards-cards.md): Lists the account's active issued cards, most recently issued first. Needs an `accessToken`. The title and rows are click targets that emit events instead of navigating — a host wires up its own routing and card-detail UI. - [CardsTableElement](https://docs.whop.com/elements/upcoming/wallet/cards-cardsTable.md): A sortable table of every issued card on an account, including cardholder, last month's spend, limit, and creation date. Rows and the create button emit events so the host owns card details and issuance flows. - [CardsChartElement](https://docs.whop.com/elements/upcoming/wallet/cards-cardsChart.md): A business account's card spend over time, using the same interactive bar chart as Whop's cards dashboard. The period picker changes the mounted chart and emits an event so the host can persist the selection. - [WhopCardElement](https://docs.whop.com/elements/upcoming/wallet/cards-whopCard.md): Renders one issued Whop Card. The element prefetches authorized secrets immediately after it mounts with a card ID, but keeps them masked until the viewer clicks it or selects `View details`. The API remains the permission authority. Includes lock and unlock… - [CardTransactionsElement](https://docs.whop.com/elements/upcoming/wallet/cards-cardTransactions.md): Every card transaction on an account, as the sortable table the dashboard shows: date, merchant, amount, cashback, status, card and cardholder, with filters for status, card and cardholder. A host can seed any of those three so the table opens on a narrowed… - [VerificationElement](https://docs.whop.com/elements/upcoming/wallet/verification.md): A banner asking the account holder to verify their identity, shown only while verification is outstanding — an account that has already verified renders nothing at all, so the element can sit permanently in a layout. The headline and body come from the API,… - [Websites](https://docs.whop.com/elements/upcoming/websites/overview.md): An account's websites: every site built on whop.site plus every domain the Whop Pixel reports, with traffic and attributed revenue per domain. Mount `websites` and it lists them with visitors, page views, sales, revenue, trend, and most-viewed pages. Mount… - [WebsitesElement](https://docs.whop.com/elements/upcoming/websites/websites.md): An account's websites in one table: every site built on whop.site — listed from the moment it exists, zeros until traffic arrives — merged by hostname with every domain the Whop Pixel reports. Rows for the whop.site ones carry a Whop mark, so the two sources… - [PixelSetupElement](https://docs.whop.com/elements/upcoming/websites/pixel-setup.md): Installs the Whop Pixel and wires conversion events: copy the snippet, check a page for it, confirm the events fire. Mount it inline, or inside your own overlay. - [Whop Elements](https://docs.whop.com/sdk/elements/overview.md): Hosted, themeable UI components you embed in your own site: checkout, wallet, chat, and more. - [Getting Started](https://docs.whop.com/sdk/elements/whop-elements.md): The main entry point for Whop embedded components. - [Create a Payouts Session](https://docs.whop.com/sdk/elements/payouts-session.md): Manages authentication and creates payout elements. - [AddPayoutMethodElement](https://docs.whop.com/sdk/elements/add-payout-method-element.md): A UI element that allows users to add a new payout method (bank account, PayPal, etc.) to their account. - [AutomaticWithdrawElement](https://docs.whop.com/sdk/elements/automatic-withdraw-element.md): A UI element that allows users to configure automatic withdrawals for their account. - [AvailableCashBreakdownElement](https://docs.whop.com/sdk/elements/available-cash-breakdown-element.md): A UI element that shows a detailed breakdown of the available (withdrawable) cash balance. - [BalanceElement](https://docs.whop.com/sdk/elements/balance-element.md): A UI element that displays the user's current balance including available, pending, and reserve amounts with an optional withdraw button. - [BalancesElement](https://docs.whop.com/sdk/elements/balances-element.md): A UI element that displays a multi-currency balance overview with expandable currency rows showing available, pending, and reserve breakdowns per currency. - [ChangeAccountCountryElement](https://docs.whop.com/sdk/elements/change-account-country-element.md): A UI element that allows users to change the country associated with their payout account. - [GenerateWithdrawalReceiptElement](https://docs.whop.com/sdk/elements/generate-withdrawal-receipt-element.md): A UI element that allows users to generate and request a receipt for a specific withdrawal. - [PendingBreakdownElement](https://docs.whop.com/sdk/elements/pending-breakdown-element.md): A UI element that displays a breakdown of pending balance amounts that are being processed. - [ReserveBreakdownElement](https://docs.whop.com/sdk/elements/reserve-breakdown-element.md): A UI element that shows a breakdown of reserve balance amounts explaining held funds and their expected availability. - [ResetAccountElement](https://docs.whop.com/sdk/elements/reset-account-element.md): A UI element that allows users to reset their payout account. - [StatusBannerElement](https://docs.whop.com/sdk/elements/status-banner-element.md): A UI element that displays a status banner indicating the user's account verification and compliance status. - [TreasuryBreakdownElement](https://docs.whop.com/sdk/elements/treasury-breakdown-element.md): A UI element that displays a breakdown of treasury funds including crypto portfolio holdings. - [VerifyElement](https://docs.whop.com/sdk/elements/verify-element.md): A UI element that guides users through identity verification (KYC) and compliance requirements. - [WithdrawButtonElement](https://docs.whop.com/sdk/elements/withdraw-button-element.md): A UI element that renders a button for initiating withdrawals. - [WithdrawElement](https://docs.whop.com/sdk/elements/withdraw-element.md): A UI element that provides a complete withdrawal form for users to request fund transfers. - [WithdrawalBreakdownElement](https://docs.whop.com/sdk/elements/withdrawal-breakdown-element.md): A UI element that displays a detailed breakdown of a specific withdrawal. - [WithdrawalsElement](https://docs.whop.com/sdk/elements/withdrawals-element.md): A UI element that displays a list of the user's past withdrawals. - [Create a Chat Session](https://docs.whop.com/sdk/elements/chat-session.md): Manages authentication and creates chat elements. - [ChatElement](https://docs.whop.com/sdk/elements/chat-element.md): A UI element that displays a chat interface. - [DmsListElement](https://docs.whop.com/sdk/elements/dms-list-element.md): A UI element that displays a dms list. - [SearchElement](https://docs.whop.com/sdk/elements/search-element.md): A UI element that allows users to search for messages in a channel, DM, or support chat. - [Create a Wallet Session](https://docs.whop.com/sdk/elements/wallet-session.md): Manages authentication and creates wallet elements. - [Types](https://docs.whop.com/sdk/elements/types.md): Shared type definitions for Whop embedded components - [Styling Reference](https://docs.whop.com/sdk/elements/styling-reference.md): Stable CSS class names applied to Whop embeddable components - [Whop CLI](https://docs.whop.com/cli/overview.md): Install the Whop CLI, sign in, and manage your whole business from the terminal: 51 command groups across commerce, money, ads, and apps. - [CLI Commands](https://docs.whop.com/cli/commands.md): Every Whop CLI command group and subcommand, with descriptions from the CLI itself. Captured from whop 0.16.1. - [Agent Mode](https://docs.whop.com/cli/agent-mode.md): Sync Whop skills into your agent and use the CLI's machine-readable output flags. ## Whop API reference The versioned Whop API — endpoints under /api-reference/beta. New integrations start here; pin a dated version with the Api-Version-Date header. Resources not listed here are documented in the sections above and remain fully supported. - [Overview](https://docs.whop.com/api-reference/beta/overview.md): What the API does, how requests work, and a map of every resource. - [Webhooks](https://docs.whop.com/developer/guides/webhooks.md): Receive payment, membership, and event notifications from Whop in realtime. - [Account](https://docs.whop.com/api-reference/beta/accounts/account.md): An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports. - [Business Types and Industries](https://docs.whop.com/api-reference/beta/accounts/business-types.md): The business_type, industry_group, and industry_type values that classify an account. - [List Accounts](https://docs.whop.com/api-reference/beta/accounts/list-accounts.md): Lists accounts visible to the credential. User tokens return the user's business accounts; Account API keys return the requesting account and its connected accounts. Pass `parent_account_id` to return only that parent account's connected accounts. - [Create Account](https://docs.whop.com/api-reference/beta/accounts/create-account.md): Creates an account. User tokens create business accounts; Account API keys create connected accounts. Tax fields (`tax_remitted_by`, `tax_type`, `product_tax_code_id`, `business_address`, `tax_identifiers`) are configured with Update Account, not at creation. - [Retrieve Account](https://docs.whop.com/api-reference/beta/accounts/retrieve-account.md): Retrieves a single account by ID or public route when it is visible to the credential, including its crypto wallet. The reserved id `me` retrieves the account associated with the current Account API key; user tokens have no single account, so they must… - [Update Account](https://docs.whop.com/api-reference/beta/accounts/update-account.md): Updates an account. User tokens can update business accounts; Account API keys can update connected accounts. The reserved id `me` — accepted on Retrieve Account — resolves to the requesting account, which an Account API key cannot edit, so updates must name… - [Form Company](https://docs.whop.com/api-reference/beta/accounts/form-company.md): Starts an LLC or C-Corp formation for a business account. Defaults to an LLC; set `entity_type` to `c_corp` to form a C-Corp, which additionally requires `share_structure` and officer `roles` on every founder. On submission, the application is validated and… - [Retrieve Account Preferences](https://docs.whop.com/api-reference/beta/accounts/retrieve-account-preferences.md): Retrieves the account's preferences: a singleton settings document keyed by preference name. - [Update Account Preferences](https://docs.whop.com/api-reference/beta/accounts/update-account-preferences.md): Updates the account's preferences. Each top-level key present in the body is replaced as a whole; omitted keys are left untouched. `ads_triple_whale_integration` takes the Data-In API key to connect with, or `null` to disconnect, plus an optional… - [List Account Reserves](https://docs.whop.com/api-reference/beta/accounts/list-account-reserves.md): Lists what the account's held balance is made of, one entry per currency: the total held, why each part is held, and the days it unlocks. - [Suspend a Connected Account](https://docs.whop.com/api-reference/beta/accounts/suspend-a-connected-account.md): Suspends a connected account directly owned by the authenticated platform account. This cannot suspend the platform account itself or an account owned by another platform. - [Transfer Account Ownership](https://docs.whop.com/api-reference/beta/accounts/transfer-account-ownership.md): Transfers ownership of the account to another user, identified by user ID or email address. If the recipient already holds the owner role, ownership moves immediately; otherwise they get an invite and ownership moves when they accept. - [Account Financing approved](https://docs.whop.com/api-reference/beta/accounts/account-financing-approved.md): Sent when the account is approved for financing and buy-now-pay-later options unlock at checkout - [Account Financing denied](https://docs.whop.com/api-reference/beta/accounts/account-financing-denied.md): Sent when the account's financing application is denied - [Account Updated](https://docs.whop.com/api-reference/beta/accounts/account-updated.md): Sent when an account is updated - [User](https://docs.whop.com/api-reference/beta/users/user.md): A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. - [List Users](https://docs.whop.com/api-reference/beta/users/list-users.md): Search for users by name or username, ranked by social proximity to the authenticated user. Returns the user's most recently followed users when no query is given. - [Retrieve User](https://docs.whop.com/api-reference/beta/users/retrieve-user.md): Retrieves a user by `user_` tag or username, or the authenticated user with the reserved id `me`. Profiles include linked social accounts — reading your own profile returns every linked account, other profiles only what is public on Whop (the primary Discord… - [Update User](https://docs.whop.com/api-reference/beta/users/update-user.md): Updates a user, addressed by `user_` tag, username, or the reserved id `me` for the authenticated user. A user token updates their own global profile; an API key updates the user's account-specific profile override (account_id required). - [Check User Access](https://docs.whop.com/api-reference/beta/users/check-user-access.md): Checks whether a user has access to an account, product, or experience the caller can reach. - [List Recommended Actions](https://docs.whop.com/api-reference/beta/users/list-recommended-actions.md): Lists the recommended actions computed for the user: personal suggestions (e.g. start a business or become an affiliate) pooled with the highest-impact actions across the accounts the user owns. Business actions are tagged with their… - [List OAuth Grants](https://docs.whop.com/api-reference/beta/users/list-oauth-grants.md): Lists the authenticated user's own OAuth grants — one per app they have authorized, per account they authorized it for. The list is always the caller's own; there is no parameter for reading another user's grants. Requires a user session: an API key or an… - [Authorize an App](https://docs.whop.com/api-reference/beta/users/authorize-an-app.md): Completes the OAuth authorization step for the authenticated user: records their consent for the scopes an app asked for and mints the authorization code to hand back to it. Returns the grant, plus a `redirect_url` carrying that code — the one and only time… - [List](https://docs.whop.com/api-reference/beta/users/list.md): Lists the authenticated user's own passkeys, newest first. The list is always the caller's own; there is no parameter for reading another user's passkeys. Requires a user session: an API key or an OAuth token is refused, because a passkey confirms the… - [Register](https://docs.whop.com/api-reference/beta/users/register.md): Registers a passkey for the authenticated user from the attestation a browser produced for a `registration` challenge. Mint that challenge first with `POST /users/me/passkeys/challenge`; it is single-use and expires 5 minutes after it is issued. Requires a… - [Delete](https://docs.whop.com/api-reference/beta/users/delete.md): Deletes one of the authenticated user's own passkeys. The request body carries a WebAuthn assertion from the passkey being deleted, so possession of the credential is proven before it is removed: mint a `deletion` challenge for it first, run the ceremony… - [Create Challenge](https://docs.whop.com/api-reference/beta/users/create-challenge.md): Mints the challenge a browser needs to run a WebAuthn ceremony against the authenticated user's own passkeys. A `registration` challenge enrolls a new passkey; a `deletion` challenge is bound to the one passkey named by `passkey_id` and proves the user still… - [Retrieve](https://docs.whop.com/api-reference/beta/users/retrieve.md): Retrieves the authenticated user's settings document. Addressed only as `me` — the document always belongs to the session user. - [Update](https://docs.whop.com/api-reference/beta/users/update.md): Updates the authenticated user's settings document. Replaces the top-level keys it is given and leaves the rest untouched. - [Set](https://docs.whop.com/api-reference/beta/users/set.md): Sets the authenticated user's notification preferences. Each preference is addressed by `scope`, not by id, so a scope read back from either list endpoint can be sent straight here. - [List Experiences](https://docs.whop.com/api-reference/beta/users/list-experiences.md): Lists the authenticated user's per-experience notification levels. Experiences the user never set a level for are omitted — their effective level is `all`. - [List Topics](https://docs.whop.com/api-reference/beta/users/list-topics.md): Lists the authenticated user's topic-scoped notification preferences, plus user-agnostic platform defaults. Each filter matches preferences scoped to its value or not narrowed on that dimension. Per-experience levels are listed separately, by `GET… - [Team Member](https://docs.whop.com/api-reference/beta/team-members/team-member.md): A Team Member is a member of an account's team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like `admin` or `moderator`) or `custom` roles managed from the dashboard. - [List Team Members](https://docs.whop.com/api-reference/beta/team-members/list-team-members.md): Lists an account's team members, including pending invites (`status: "pending"`, `ausri_` ids; `user` is `null` for invites sent to an email with no Whop account yet). For accepted members, `email` requires the `company:authorized_user:email:read` scope and… - [Create Team Member](https://docs.whop.com/api-reference/beta/team-members/create-team-member.md): Adds a member to an account's team with a system role. Identify them by exactly one of `user_id` or `email`. If the person has not yet accepted — or the email does not belong to a Whop account yet — an invitation is sent instead and the response is `202`… - [Retrieve Team Member](https://docs.whop.com/api-reference/beta/team-members/retrieve-team-member.md): Retrieves a team member by ID. `email` requires the `company:authorized_user:email:read` scope and is `null` otherwise. - [Update Team Member](https://docs.whop.com/api-reference/beta/team-members/update-team-member.md): Changes a team member's system role. Requires a user session — account API keys cannot change member roles. The account owner's role cannot be changed, and you cannot change your own role. - [Delete Team Member](https://docs.whop.com/api-reference/beta/team-members/delete-team-member.md): Removes a team member from the account, or revokes a pending invite when given an `ausri_` ID. A user session may delete its own membership to leave the team without the delete scope. Removing a member on the `workforce` role is also allowed with the… - [Member](https://docs.whop.com/api-reference/beta/members/member.md): A Member is one buyer's relationship with an account — one record per customer regardless of how many memberships they hold. It carries relationship-level state: whether they have joined or left, their access level (`customer`, `admin`, or `no_access`), when… - [List Members](https://docs.whop.com/api-reference/beta/members/list-members.md): Lists the members of an account. A member is one buyer's relationship with the account, regardless of how many memberships they hold. - [Retrieve Member](https://docs.whop.com/api-reference/beta/members/retrieve-member.md): Retrieves a member by ID. Accessible to the account and to the member's own user. - [List Member Logs](https://docs.whop.com/api-reference/beta/members/list-member-logs.md): Lists activity for a member and all of their non-drafted memberships, most recent first. - [Member Created](https://docs.whop.com/api-reference/beta/members/member-created.md): Sent when a member is created - [Member Updated](https://docs.whop.com/api-reference/beta/members/member-updated.md): Sent when a member is updated - [List Economic Intelligence](https://docs.whop.com/api-reference/beta/economic-intelligence/list-economic-intelligence.md): Lists all recommended actions Economic Intelligence has generated for the account, newest first. Filter with `status=ready` for actions that are current. - [Run Economic Intelligence](https://docs.whop.com/api-reference/beta/economic-intelligence/run-economic-intelligence.md): Harnesses Economic Intelligence to generate recommended actions that lead the business down the most optimal path to the next dollar. Returns a `queued` recommendation right away. Poll the list endpoint until it is `ready` or `failed`. - [List Webhooks](https://docs.whop.com/api-reference/beta/webhooks/list-webhooks.md): Returns a paginated list of webhook endpoints configured for an account, ordered by most recently created. - [Create Webhook](https://docs.whop.com/api-reference/beta/webhooks/create-webhook.md): Creates a webhook endpoint that receives event notifications via HTTP POST. - [Retrieve Webhook](https://docs.whop.com/api-reference/beta/webhooks/retrieve-webhook.md): Retrieves the details of an existing webhook. - [Update Webhook](https://docs.whop.com/api-reference/beta/webhooks/update-webhook.md): Updates a webhook endpoint's URL, subscribed events, pinned payload version, or enabled state. - [Delete Webhook](https://docs.whop.com/api-reference/beta/webhooks/delete-webhook.md): Permanently deletes a webhook endpoint. Returns `true` on success, matching the legacy proxy response. - [List Deliveries](https://docs.whop.com/api-reference/beta/webhooks/list-deliveries.md): 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. - [Replay Delivery](https://docs.whop.com/api-reference/beta/webhooks/replay-delivery.md): Re-sends the exact payload of a past delivery to the webhook's current URL and returns the delivery result. By default the replay keeps the original `webhook-id`, so consumers that deduplicate on it can drop events they already processed. Pass… - [Replay Deliveries in a Range](https://docs.whop.com/api-reference/beta/webhooks/replay-deliveries-in-a-range.md): Re-sends the webhook's past deliveries within a time window, optionally limited to specific events or to messages whose most recent delivery attempt failed. Fire and forget: nothing about the replay is stored, and each re-send appears as a new entry in the… - [Send Test Event](https://docs.whop.com/api-reference/beta/webhooks/send-test-event.md): Sends a sample payload for the given event to the webhook's URL and returns the delivery result. - [Stats](https://docs.whop.com/api-reference/beta/stats/stats.md): Stats represent aggregated activity for an account over time. They help you understand revenue, transactions, disputes, members, referrals, and advertising performance across reporting periods like days, weeks, or months. - [List Metrics](https://docs.whop.com/api-reference/beta/stats/list-metrics.md): Lists every metric you can query, with its unit and the properties you can filter or break it down by. - [Retrieve Metric](https://docs.whop.com/api-reference/beta/stats/retrieve-metric.md): Retrieves a metric as a time series of points for an account or user over a time range. The `market_prices` metric is public and requires no authentication. - [Verification](https://docs.whop.com/api-reference/beta/verifications/verification.md): A Verification represents a legal identity for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. - [List Verifications](https://docs.whop.com/api-reference/beta/verifications/list-verifications.md): Returns verifications for an account, including their status and any required actions. - [Create Verification](https://docs.whop.com/api-reference/beta/verifications/create-verification.md): Starts a hosted verification session for an account or user, or returns the active session when one already exists. Any fields you include in the request body are used to prefill the session. Send `documents` (with `document_type`) to instead verify the… - [Retrieve Verification](https://docs.whop.com/api-reference/beta/verifications/retrieve-verification.md): Returns verifications for an account, including their status and any required actions. - [Update Verification](https://docs.whop.com/api-reference/beta/verifications/update-verification.md): Updates editable profile details or submits answers for items returned in `requested_information`. Once a verification is `approved` its profile details are locked and can no longer be edited. - [IdentityProfile Updated](https://docs.whop.com/api-reference/beta/verifications/identityprofile-updated.md): Sent whenever an identity profile changes state — a verification is approved, needs action, or is rejected, or a Whop review opens or clears. Every other identity_profile event is also delivered as an identity_profile.updated, so you can subscribe to this… - [List Exports](https://docs.whop.com/api-reference/beta/exports/list-exports.md): Lists the exports requested for an account, newest first. Only exports of resources the credential is allowed to export are returned. - [Create Export](https://docs.whop.com/api-reference/beta/exports/create-export.md): Starts an asynchronous export of a resource for an account. Returns the export in `pending`; poll `GET /exports/{id}` until `download_url` is set. - [Retrieve Export](https://docs.whop.com/api-reference/beta/exports/retrieve-export.md): Fetches an export's status and, once complete, its download link. - [List Notifications](https://docs.whop.com/api-reference/beta/notifications/list-notifications.md): 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. - [Send Notification](https://docs.whop.com/api-reference/beta/notifications/send-notification.md): 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. - [Retrieve Notification](https://docs.whop.com/api-reference/beta/notifications/retrieve-notification.md): 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. - [List Notification Badges](https://docs.whop.com/api-reference/beta/notifications/list-notification-badges.md): 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). - [Mark Notifications Read](https://docs.whop.com/api-reference/beta/notifications/mark-notifications-read.md): 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. - [List Notification Topics](https://docs.whop.com/api-reference/beta/notifications/list-notification-topics.md): Lists the platform's visible notification topics — the categories users can set notification preferences on. App-created topics are internal and not returned. - [List Payments](https://docs.whop.com/api-reference/beta/payments/list-payments.md): Lists payments, newest first. Without filters this is every payment the caller can read: a company credential's own account, or for a user every account they can read payments for. Filters narrow by account, buyer, product, plan, membership, status, billing… - [Create Payment](https://docs.whop.com/api-reference/beta/payments/create-payment.md): Charges a buyer for a plan. Pass a payment method already on file (`member_id` and `payment_method_id`), or a `confirmation_token` describing a method the buyer just supplied. Collection runs in the background: the response is the payment as created, not its… - [Retrieve Payment](https://docs.whop.com/api-reference/beta/payments/retrieve-payment.md): Returns one payment. Related records are ids — resolve a plan, membership, member or shipment on its own endpoint, and list this payment's refunds, disputes or Resolution Center cases with `?payment_id=`. - [Capture payment](https://docs.whop.com/api-reference/beta/payments/capture-payment.md): Captures the full amount of a card payment created with `capture: false`. The payment must still be in `requires_capture` before `capture_expires_at`. Partial capture, multiple captures, capturing more than the authorized amount, and tips are not supported. - [List Payment Fees](https://docs.whop.com/api-reference/beta/payments/list-payment-fees.md): Returns the fee breakdown of one payment — Whop's fee, processing, affiliate and other lines — each in the currency it was collected in and converted to the payment's settlement currency. The list is complete in one page. - [Refund Payment](https://docs.whop.com/api-reference/beta/payments/refund-payment.md): Issues a full or partial refund for a payment. The refund is processed through the original payment processor and the membership status is updated accordingly. - [Resume a parked renewal](https://docs.whop.com/api-reference/beta/payments/resume-a-parked-renewal.md): 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… - [Retry Payment](https://docs.whop.com/api-reference/beta/payments/retry-payment.md): Retries a failed or pending payment. This re-attempts the charge using the original payment method and plan details. - [Update payment return URL](https://docs.whop.com/api-reference/beta/payments/update-payment-return-url.md): Changes where the buyer lands after completing an off-site step, up until they return. Accepts either a secret key or the payment's own `client_secret`, so the surface that knows the final destination can set it. - [Retrieve payment status](https://docs.whop.com/api-reference/beta/payments/retrieve-payment-status.md): Retrieves how far a payment has got and what the buyer must do next, if anything. A payment is collected in the background, so poll this rather than reading the create response. Accepts either a secret key or the payment's own `client_secret`, so the surface… - [Void Payment](https://docs.whop.com/api-reference/beta/payments/void-payment.md): Voids a payment that has not yet been settled. Voiding cancels the payment before it is captured by the payment processor. - [List Refunds](https://docs.whop.com/api-reference/beta/refunds/list-refunds.md): Lists refunds, newest first. Without filters this is every refund the caller can read; narrow it to one payment with `payment_id`, one account with `account_id`, or one buyer with `user_id`. - [Retrieve Refund](https://docs.whop.com/api-reference/beta/refunds/retrieve-refund.md): Returns one refund. - [Confirmation Token](https://docs.whop.com/api-reference/beta/confirmation-tokens/confirmation-token.md): A Confirmation Token is a single-use, short-lived reference to a payment method and billing details collected from a buyer. Its response contains only a display-safe preview and never returns the underlying payment credential. - [Create Confirmation Token](https://docs.whop.com/api-reference/beta/confirmation-tokens/create-confirmation-token.md): Mints a single-use, short-lived confirmation token from what the buyer entered on your collection surface: the payment method payload, billing details, and attested save consent. Public and rate-limited — the account_id in the body scopes the token but does… - [Retrieve Confirmation Token](https://docs.whop.com/api-reference/beta/confirmation-tokens/retrieve-confirmation-token.md): Retrieves a token's display-safe preview — never the underlying payment credential. Public and rate-limited: the account_id query param must match the account the token was minted for. - [Update setup return URL](https://docs.whop.com/api-reference/beta/setup-intents/update-setup-return-url.md): Changes where the buyer lands after completing an off-site step, up until they return. Accepts either a secret key or the setup's own `client_secret`, so the surface that knows the final destination can set it. - [Retrieve setup status](https://docs.whop.com/api-reference/beta/setup-intents/retrieve-setup-status.md): Retrieves how far a setup has got and what the buyer must do next, if anything. Collection runs in the background, so poll this rather than reading the create response. Accepts either a secret key or the setup's own `client_secret`, so the surface collecting… - [Disputes](https://docs.whop.com/api-reference/beta/disputes/dispute.md): A Dispute is a chargeback a customer files against a payment through their bank, or an inquiry that may become one. It carries the disputed payment, a deadline to respond, your evidence, and the outcome once the processor rules. - [List Disputes](https://docs.whop.com/api-reference/beta/disputes/list-disputes.md): Lists the disputes across the accounts you can read. - [Retrieve Dispute](https://docs.whop.com/api-reference/beta/disputes/retrieve-dispute.md): Retrieves a single dispute. - [Update Dispute](https://docs.whop.com/api-reference/beta/disputes/update-dispute.md): Edits a dispute's evidence, while it is still editable. Sending it is a separate call. - [Submit Dispute](https://docs.whop.com/api-reference/beta/disputes/submit-dispute.md): Sends a dispute's evidence to the payment processor. This is final — it cannot be edited or sent again. - [Upload Dispute Evidence](https://docs.whop.com/api-reference/beta/disputes/upload-dispute-evidence.md): Replaces the full set of uploaded evidence documents on a dispute, beyond the four fixed evidence slots. Upload files through `POST /files` and reference them by `id`, or send the files as multipart file parts to upload and attach in one call. Send every… - [Retrieve Dispute Summary](https://docs.whop.com/api-reference/beta/disputes/retrieve-dispute-summary.md): Totals up the same disputes the list returns, so you can build status tabs and totals without paging through them. - [Dispute Created](https://docs.whop.com/api-reference/beta/disputes/dispute-created.md): Sent when a dispute is created - [Dispute Updated](https://docs.whop.com/api-reference/beta/disputes/dispute-updated.md): Sent when a dispute is updated - [Dispute Alerts](https://docs.whop.com/api-reference/beta/dispute-alerts/dispute-alert.md): A Dispute alert is an early warning from a card issuer that a settled payment is being questioned, ahead of any chargeback. `type` separates fraud reports (`early_fraud_warning`), pre-dispute notices (`dispute_alert`), and Visa RDR cases the network already… - [List Dispute Alerts](https://docs.whop.com/api-reference/beta/dispute-alerts/list-dispute-alerts.md): Lists the dispute alerts and early fraud warnings across the accounts you can read. - [Retrieve Dispute Alert](https://docs.whop.com/api-reference/beta/dispute-alerts/retrieve-dispute-alert.md): Retrieves a single dispute alert or early fraud warning by ID. - [Dispute Alert Created](https://docs.whop.com/api-reference/beta/dispute-alerts/dispute-alert-created.md): Sent when a dispute alert is created - [List Resolution Center Cases](https://docs.whop.com/api-reference/beta/resolution-center-cases/list-resolution-center-cases.md): Lists resolution center cases. Without `account_id` you get every case you can read — the ones you opened as a buyer and every account you are a team member of; the filters narrow that list. - [Open a Case as the Customer](https://docs.whop.com/api-reference/beta/resolution-center-cases/open-a-case-as-the-customer.md): Opens a case, as the customer, against one of your own payments. Provide the payment (`receipt_id`), the `reason`, and a `message`. - [Retrieve Resolution Center Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/retrieve-resolution-center-case.md): Retrieves a single resolution center case with its full event timeline. - [Accept a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/accept-a-case.md): Accepts the case in the customer's favor, as the merchant: refunds the payment in full and closes the case. - [Appeal a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/appeal-a-case.md): Appeals a decision, as the customer, on a case that closed in the merchant's favor. Escalates the case to Whop for platform review. A case can be appealed once. - [Deny a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/deny-a-case.md): Denies the case, as the merchant: rejects the claim and closes the case with no refund. - [List Resolution Center Case Events](https://docs.whop.com/api-reference/beta/resolution-center-cases/list-resolution-center-case-events.md): Lists the case timeline, newest first. Events the viewer is not allowed to see are omitted — a customer reads the customer-visible timeline, the merchant reads the full one. - [Reply to a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/reply-to-a-case.md): Replies to an open request for information on the case. As the merchant this answers Whop's request (valid while the case awaits your information); as the customer it provides the information requested from you. The actor is resolved from the credential. - [Request Information from the Customer](https://docs.whop.com/api-reference/beta/resolution-center-cases/request-information-from-the-customer.md): Asks the customer for more information, as the merchant. Allowed up to 3 times per case before you must accept or deny it. - [Withdraw a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/withdraw-a-case.md): Withdraws (cancels) a case you opened, as the customer. Only possible while the case is still open. - [Retrieve Resolution Center Case Summary](https://docs.whop.com/api-reference/beta/resolution-center-cases/retrieve-resolution-center-case-summary.md): Aggregates the same cases `GET /resolution_center_cases` lists, using the same filters. Use it to build status tabs and issue filters without paging the whole list. - [Ledger Activity](https://docs.whop.com/api-reference/beta/ledgers/ledger-activity.md): A Ledger Activity row is a single financial event on an account's ledger — a payment, payout, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so… - [Get Financial Report](https://docs.whop.com/api-reference/beta/ledgers/get-financial-report.md): Returns a financial report — balance activity, income statement, or balance summary — for an account over a date range. - [Get Financial Report Breakdown](https://docs.whop.com/api-reference/beta/ledgers/get-financial-report-breakdown.md): Returns the top entities behind one high-level financial report bucket and an aggregate remainder. - [List Financial Activity](https://docs.whop.com/api-reference/beta/ledgers/list-financial-activity.md): Returns an account's or user's activity feed: every movement of money in or out. - [Financial Activity Funds available](https://docs.whop.com/api-reference/beta/ledgers/financial-activity-funds-available.md): Sent when a settlement moves one release date's pending funds into the account's available balance — one event per release date that cleared, carrying that settlement's ledger line. Its posted_at is the release date at midnight UTC, the same value as… - [Payouts](https://docs.whop.com/api-reference/beta/payouts/payout.md): Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. - [List Payouts](https://docs.whop.com/api-reference/beta/payouts/list-payouts.md): Lists an account's or user's payouts, newest first. - [Create Payout](https://docs.whop.com/api-reference/beta/payouts/create-payout.md): Sends money from an account or user balance to a saved payout method for that owner. - [Retrieve Payout](https://docs.whop.com/api-reference/beta/payouts/retrieve-payout.md): Fetches one payout by its `wdrl_` ID, or by the `cofr_` conversion request ID a stablecoin payout carries as `payout_request_id` — both ids answer with the same payout object. - [Cancel Payout](https://docs.whop.com/api-reference/beta/payouts/cancel-payout.md): Cancels a payout that is still in review and returns the funds, fees included, to the balance. A payout can be canceled while its status is `in_review`. A `requested` payout is still being prepared (its funds may be converting) and answers 409 until it… - [List Saved Payout Methods](https://docs.whop.com/api-reference/beta/payouts/list-saved-payout-methods.md): Lists the bank accounts, wallets, and crypto addresses an account or user can pay out to, newest first. - [Create Saved Payout Method](https://docs.whop.com/api-reference/beta/payouts/create-saved-payout-method.md): Saves a new place an account or user can pay out to. Sensitive details are vaulted in transit and never stored raw. - [Update Saved Payout Method](https://docs.whop.com/api-reference/beta/payouts/update-saved-payout-method.md): Changes the label used to identify a saved payout method or makes it the account's default payout method. - [Delete Saved Payout Method](https://docs.whop.com/api-reference/beta/payouts/delete-saved-payout-method.md): Deletes a saved payout method so it can no longer receive payouts. - [Create Payout Quote](https://docs.whop.com/api-reference/beta/payouts/create-payout-quote.md): Creates a short-lived, provider-backed quote for a payout. No funds move until the returned quote_token is submitted to POST /payouts. An Idempotency-Key header is required. - [List Supported Payout Methods](https://docs.whop.com/api-reference/beta/payouts/list-supported-payout-methods.md): Lists the payout methods an account or user is eligible to add. - [PayoutMethod Created](https://docs.whop.com/api-reference/beta/payouts/payoutmethod-created.md): Sent when a payout method is created - [Payout Created](https://docs.whop.com/api-reference/beta/payouts/payout-created.md): Sent when a payout is created (this event family replaces withdrawal.*) - [Payout Reversed](https://docs.whop.com/api-reference/beta/payouts/payout-reversed.md): Sent when a settled payout is reversed and the funds return to the balance (this event family replaces withdrawal.*) - [Payout Updated](https://docs.whop.com/api-reference/beta/payouts/payout-updated.md): Sent when a payout's status changes (this event family replaces withdrawal.*) - [Cards](https://docs.whop.com/api-reference/beta/cards/card.md): Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. - [List Card Transactions](https://docs.whop.com/api-reference/beta/cards/list-card-transactions.md): Lists an account's card transactions, newest first. Defaults to the account the credential belongs to. Covers every card the owner has ever had, including canceled cards and spend that predates a re-application, and team members only see transactions on the… - [Retrieve Card Transaction](https://docs.whop.com/api-reference/beta/cards/retrieve-card-transaction.md): Fetches a single card transaction by its `citx_` identifier. The owner defaults to the account the credential belongs to. - [List Cards](https://docs.whop.com/api-reference/beta/cards/list-cards.md): Lists the Whop cards of an account or user, including ones still being set up. Team members only see the cards assigned to them. - [Create Card](https://docs.whop.com/api-reference/beta/cards/create-card.md): Issue a virtual card, or apply for card issuing. An account with no application files one here and gets back a `202`; call again to issue the card once it is approved. - [Retrieve Card](https://docs.whop.com/api-reference/beta/cards/retrieve-card.md): Retrieve a single card. - [Update Card](https://docs.whop.com/api-reference/beta/cards/update-card.md): Update, freeze, or cancel a card. Updating the card's name, billing address, or limits requires both `payout:account:update` and `company:balance:read`; a card's assigned holder may update their own card's pin and frozen state with any user token. - [Card Application Approved](https://docs.whop.com/api-reference/beta/cards/card-application-approved.md): Sent when a card application is approved - [Card Application Created](https://docs.whop.com/api-reference/beta/cards/card-application-created.md): Sent when a card application is created - [Card Application Denied](https://docs.whop.com/api-reference/beta/cards/card-application-denied.md): Sent when a card application is denied - [Card Application Updated](https://docs.whop.com/api-reference/beta/cards/card-application-updated.md): Sent when a card application is updated - [CardTransaction Completed](https://docs.whop.com/api-reference/beta/cards/cardtransaction-completed.md): Sent when a card transaction is completed - [CardTransaction Created](https://docs.whop.com/api-reference/beta/cards/cardtransaction-created.md): Sent when a card transaction is created - [CardTransaction Declined](https://docs.whop.com/api-reference/beta/cards/cardtransaction-declined.md): Sent when a card transaction is declined - [CardTransaction Reversed](https://docs.whop.com/api-reference/beta/cards/cardtransaction-reversed.md): Sent when a card transaction is reversed - [CardTransaction Updated](https://docs.whop.com/api-reference/beta/cards/cardtransaction-updated.md): Sent when a card transaction is updated - [Card Canceled](https://docs.whop.com/api-reference/beta/cards/card-canceled.md): Sent when a card is canceled - [Card Created](https://docs.whop.com/api-reference/beta/cards/card-created.md): Sent when a card is created - [Card Frozen](https://docs.whop.com/api-reference/beta/cards/card-frozen.md): Sent when a card is frozen - [Card Updated](https://docs.whop.com/api-reference/beta/cards/card-updated.md): Sent when a card is updated - [Cashback Rule](https://docs.whop.com/api-reference/beta/cashback-rules/cashback-rule.md): Cashback rules designate a funding platform, a merchant name and category, a rate, and an eligibility window. An optional account ID limits the rule to one of the platform's direct connected accounts. - [Create Cashback Rule](https://docs.whop.com/api-reference/beta/cashback-rules/create-cashback-rule.md): Creates a future-dated card cashback rule funded by the authenticated platform account. Requires payout:transfer_funds. Both the raw merchant name and four-digit MCC are required. Optionally limit the rule to one direct connected account. The funding account… - [List Cashback Rules](https://docs.whop.com/api-reference/beta/cashback-rules/list-cashback-rules.md): Lists all cashback rules funded by the authenticated platform account. Includes scheduled, expired, and discarded rules. Requires payout:transfer:read. Account-scoped credentials are required; there is no caller-supplied funding-account filter. - [Update Cashback Rule](https://docs.whop.com/api-reference/beta/cashback-rules/update-cashback-rule.md): Updates a cashback rule funded by the authenticated platform account. Requires payout:transfer_funds. Only merchant_name, merchant_category_code, description, and expires_at can change; starts_at, rate_bps, funding_account_id, and scoped_account_id are… - [Transfers](https://docs.whop.com/api-reference/beta/transfers/transfer.md): Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. - [List Transfers](https://docs.whop.com/api-reference/beta/transfers/list-transfers.md): Lists an account's transfers. - [Create Transfer](https://docs.whop.com/api-reference/beta/transfers/create-transfer.md): Moves money between accounts, or into a claim link anyone with the URL can redeem. - [Retrieve Transfer](https://docs.whop.com/api-reference/beta/transfers/retrieve-transfer.md): Retrieves a single transfer. - [List Transfer Recipients](https://docs.whop.com/api-reference/beta/transfers/list-transfer-recipients.md): Lists the people and accounts you can send money to. - [Transfer Completed](https://docs.whop.com/api-reference/beta/transfers/transfer-completed.md): Sent when a transfer is completed - [Transfer Created](https://docs.whop.com/api-reference/beta/transfers/transfer-created.md): Sent when a transfer is created - [Transfer Failed](https://docs.whop.com/api-reference/beta/transfers/transfer-failed.md): Sent when a transfer is failed - [Deposits](https://docs.whop.com/api-reference/beta/deposits/deposit.md): Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. - [Create Deposit](https://docs.whop.com/api-reference/beta/deposits/create-deposit.md): Retrieve the deposit methods for an account, including crypto and bank transfer. Crypto deposits require a $10 minimum. - [Deposit Succeeded](https://docs.whop.com/api-reference/beta/deposits/deposit-succeeded.md): Sent when a deposit is succeeded - [Swaps](https://docs.whop.com/api-reference/beta/swaps/swap.md): Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap. - [List Swaps](https://docs.whop.com/api-reference/beta/swaps/list-swaps.md): Retrieve the account's completed or pending swaps — currently just the latest one. - [Create Swap](https://docs.whop.com/api-reference/beta/swaps/create-swap.md): Swaps one token for another from the account's wallet, or converts between fiat currencies in the account's ledger at the mid-market rate. Crypto swaps finish in the background — check the swap for its status. - [Retrieve Swap](https://docs.whop.com/api-reference/beta/swaps/retrieve-swap.md): Retrieves a single swap and its status. - [Create Swap Quote](https://docs.whop.com/api-reference/beta/swaps/create-swap-quote.md): Previews the price of a swap. Fiat pairs quote the in-ledger mid-market conversion — the same rate creating the swap fills at. No funds move and nothing is saved. - [Swap Completed](https://docs.whop.com/api-reference/beta/swaps/swap-completed.md): Sent when a swap is completed - [Product](https://docs.whop.com/api-reference/beta/products/product.md): A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. - [List Products](https://docs.whop.com/api-reference/beta/products/list-products.md): Returns a paginated list of products. Omit `account_id` to search the public marketplace. - [Create Product](https://docs.whop.com/api-reference/beta/products/create-product.md): Creates a new product for an account. - [Retrieve Product](https://docs.whop.com/api-reference/beta/products/retrieve-product.md): Retrieves a product. Public — no credentials. - [Update Product](https://docs.whop.com/api-reference/beta/products/update-product.md): Updates an existing product. - [Delete Product](https://docs.whop.com/api-reference/beta/products/delete-product.md): Deletes a product. Only products with no memberships, entries, reviews, or invoices can be deleted. - [Publish Product](https://docs.whop.com/api-reference/beta/products/publish-product.md): 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… - [Unpublish Product](https://docs.whop.com/api-reference/beta/products/unpublish-product.md): Removes a product from the whop.com marketplace. The product moves to `not_available`. - [Product Created](https://docs.whop.com/api-reference/beta/products/product-created.md): Sent when a product is created - [Product Deleted](https://docs.whop.com/api-reference/beta/products/product-deleted.md): Sent when a product is deleted - [Product Published](https://docs.whop.com/api-reference/beta/products/product-published.md): Sent when a product is published - [Product Unpublished](https://docs.whop.com/api-reference/beta/products/product-unpublished.md): Sent when a product is unpublished - [Product Updated](https://docs.whop.com/api-reference/beta/products/product-updated.md): Sent when a product is updated - [Plan](https://docs.whop.com/api-reference/beta/plans/plan.md): A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility. - [Calculate Tax](https://docs.whop.com/api-reference/beta/plans/calculate-tax.md): Use it in a checkout preview to show the buyer their subtotal, tax, and total. The request only reads data. It doesn't create a checkout, reserve inventory, or charge the buyer. - [List Plans](https://docs.whop.com/api-reference/beta/plans/list-plans.md): Returns a paginated list of plans. Omit `account_id` and pass `product_ids` to list a product's public buyable plans. - [Create Plan](https://docs.whop.com/api-reference/beta/plans/create-plan.md): Create a new pricing plan for a product. The plan defines the billing interval, price, and availability for customers. - [Retrieve Plan](https://docs.whop.com/api-reference/beta/plans/retrieve-plan.md): Retrieves the details of an existing plan. - [Update Plan](https://docs.whop.com/api-reference/beta/plans/update-plan.md): Update a plan's pricing, billing interval, visibility, stock, and other settings. - [Delete Plan](https://docs.whop.com/api-reference/beta/plans/delete-plan.md): Permanently delete a plan from a product. Existing memberships on this plan will not be affected. - [Plan Created](https://docs.whop.com/api-reference/beta/plans/plan-created.md): Sent when a plan is created - [Plan Deleted](https://docs.whop.com/api-reference/beta/plans/plan-deleted.md): Sent when a plan is deleted - [Plan Updated](https://docs.whop.com/api-reference/beta/plans/plan-updated.md): Sent when a plan is updated - [List Promo Codes](https://docs.whop.com/api-reference/beta/promo-codes/list-promo-codes.md): Lists promo codes for an account with cursor pagination, filters, and sorting. - [Create Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/create-promo-code.md): Creates a promo code for an account. First-party sessions may attach an affiliate. - [Retrieve Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/retrieve-promo-code.md): Retrieves a promo code by ID. - [Delete Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/delete-promo-code.md): Archives a promo code so it cannot be used in future checkouts. - [Activate Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/activate-promo-code.md): Turns an inactive promo code back on so it can be redeemed at checkout. - [Deactivate Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/deactivate-promo-code.md): Turns off an active promo code so it can no longer be redeemed at checkout. - [Membership](https://docs.whop.com/api-reference/beta/memberships/membership.md): A Membership is a customer's purchase of a plan: the subscription or one-time grant that gives them access to a product. It tracks billing state (`active`, `trialing`, `past_due`, and so on), the current period, pending cancellations, custom metadata, and… - [List Memberships](https://docs.whop.com/api-reference/beta/memberships/list-memberships.md): Lists every membership the caller can read: an account API key its account's; a user credential their own plus those of every account they manage. `account_id` and `user_id` only narrow that list — values outside the caller's reach return fewer results, not… - [Retrieve Membership](https://docs.whop.com/api-reference/beta/memberships/retrieve-membership.md): Retrieves a membership by ID or license key. Accessible to the account and to the membership's own user. - [Update Membership](https://docs.whop.com/api-reference/beta/memberships/update-membership.md): Updates a membership: merge metadata key-value pairs, or toggle `cancel_at_period_end` — `true` schedules the cancellation for the end of the current billing period, `false` reverses a pending one. - [Cancel Membership](https://docs.whop.com/api-reference/beta/memberships/cancel-membership.md): Cancels a membership. Pass `cancel_at_period_end: true` to stop auto-renewal and keep access until the current billing period ends. Omit it (or pass `false`) to revoke access immediately. Buyers cannot cancel buy-now-pay-later (`splitit`, `sezzle`) or… - [Extend Membership](https://docs.whop.com/api-reference/beta/memberships/extend-membership.md): Adds free days to a membership, extending its current billing period, expiration date, or trial depending on the plan type. - [Pause Membership](https://docs.whop.com/api-reference/beta/memberships/pause-membership.md): Pauses a membership's recurring payment collection. The customer keeps access but is not charged until the membership is resumed. - [Resume Membership](https://docs.whop.com/api-reference/beta/memberships/resume-membership.md): Resumes a previously paused membership's recurring payment collection. Billing resumes on the next cycle. - [Resync Membership Access](https://docs.whop.com/api-reference/beta/memberships/resync-membership-access.md): 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… - [Transfer Membership](https://docs.whop.com/api-reference/beta/memberships/transfer-membership.md): Creates a one-use transfer URL for a membership. Opening the URL while logged into a different Whop account claims the membership onto that account. The membership's buyer can generate a link for their own membership with `membership:transfer` when the… - [Invite to a Membership](https://docs.whop.com/api-reference/beta/memberships/invite-to-a-membership.md): Sends an email inviting one recipient to join the account through a free plan. Identify the recipient by exactly one of `user_id` or `email`. The invitation is bound to that recipient; after signing in, accepting it immediately grants the membership without… - [Membership Activated](https://docs.whop.com/api-reference/beta/memberships/membership-activated.md): Sent when a membership is activated - [Membership Cancel at period end changed](https://docs.whop.com/api-reference/beta/memberships/membership-cancel-at-period-end-changed.md): Sent when a membership is cancel at period end changed - [Membership Deactivated](https://docs.whop.com/api-reference/beta/memberships/membership-deactivated.md): Sent when a membership is deactivated - [Membership Trial ending soon](https://docs.whop.com/api-reference/beta/memberships/membership-trial-ending-soon.md): Sent when a membership is trial ending soon - [Checkout Configuration](https://docs.whop.com/api-reference/beta/checkout-configurations/checkout-configuration.md): A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are… - [List checkout configurations](https://docs.whop.com/api-reference/beta/checkout-configurations/list-checkout-configurations.md): Lists checkout configurations for an account. - [Create a checkout configuration](https://docs.whop.com/api-reference/beta/checkout-configurations/create-a-checkout-configuration.md): Creates a reusable checkout configuration for an existing or inline plan. - [Retrieve a checkout configuration](https://docs.whop.com/api-reference/beta/checkout-configurations/retrieve-a-checkout-configuration.md): Retrieves a checkout configuration by ID. This endpoint is public so a checkout page can load from the configuration URL. - [Delete a checkout configuration](https://docs.whop.com/api-reference/beta/checkout-configurations/delete-a-checkout-configuration.md): Deletes a checkout configuration so its checkout URL can no longer be used. - [Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/payment-method-domain.md): A Payment Method Domain registers a hostname with a wallet provider so its payment methods can appear at a checkout served from that domain. The domain proves ownership by hosting the provider's association file — for Apple Pay, at… - [List Payment Method Domains](https://docs.whop.com/api-reference/beta/payment-method-domains/list-payment-method-domains.md): Lists payment method domains. Without `account_id`, returns the caller's own domains and those of every connected account. - [Create Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/create-payment-method-domain.md): Registers a hostname with the wallet provider and attempts verification inline. Returns `verified` when the provider fetched the domain-association file (for Apple Pay, `/.well-known/apple-developer-merchantid-domain-association`), or `pending` when it could… - [Retrieve Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/retrieve-payment-method-domain.md): Retrieves a payment method domain to check its verification status. - [Delete Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/delete-payment-method-domain.md): Unregisters a payment method domain so its wallet payment methods stop rendering there. - [Verify Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/verify-payment-method-domain.md): Re-attempts provider verification of a pending domain once the association file is hosted. Fails with a `bad_request` explaining what to fix; verifying an already `verified` domain is a no-op. - [List Shipments](https://docs.whop.com/api-reference/beta/shipments/list-shipments.md): Returns a paginated list of shipments for an account. - [Create Shipment](https://docs.whop.com/api-reference/beta/shipments/create-shipment.md): Attaches a carrier tracking number to a payment and begins tracking it. - [Retrieve Shipment](https://docs.whop.com/api-reference/beta/shipments/retrieve-shipment.md): Retrieves a shipment by its id, or by the payment id it fulfills. - [Update Shipment](https://docs.whop.com/api-reference/beta/shipments/update-shipment.md): Updates a shipment's tracking number and re-tracks it with the carrier. - [Partners](https://docs.whop.com/api-reference/beta/partners/partner.md): The Partners API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard. - [Enroll as a Whop partner](https://docs.whop.com/api-reference/beta/partners/enroll-as-a-whop-partner.md): Enrolls the calling user in the Whop partner program, making their partner businesses eligible for earnings. Idempotent — enrolling again keeps the original enrollment time. - [List referred businesses](https://docs.whop.com/api-reference/beta/partners/list-referred-businesses.md): Lists the businesses the authenticated user referred onto Whop, most recent first. - [Retrieve a referred business](https://docs.whop.com/api-reference/beta/partners/retrieve-a-referred-business.md): Retrieves a single referred business and its referral terms. - [List referred business earnings](https://docs.whop.com/api-reference/beta/partners/list-referred-business-earnings.md): Lists the earnings Whop pays out for one referred business's activity, most recent first. - [Retrieve the leaderboard](https://docs.whop.com/api-reference/beta/partners/retrieve-the-leaderboard.md): 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. - [Retrieve a partner reward link](https://docs.whop.com/api-reference/beta/partners/retrieve-a-partner-reward-link.md): 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. - [List the users the caller referred](https://docs.whop.com/api-reference/beta/partners/list-the-users-the-caller-referred.md): Lists the users the caller referred onto Whop (newest first), each with the second-tier earnings the caller has made from that user's businesses. - [Bounty](https://docs.whop.com/api-reference/beta/bounties/bounty.md): A Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills. - [List Bounties](https://docs.whop.com/api-reference/beta/bounties/list-bounties.md): Lists bounties visible to the credential — for an account API key, the account's bounties including scheduled drafts; for a user token, the bounties the user can see and work. - [Create Bounty](https://docs.whop.com/api-reference/beta/bounties/create-bounty.md): Creates a bounty and escrows its reward pool. Publishes immediately, or as a scheduled draft when you set `publish_at`. - [Retrieve Bounty](https://docs.whop.com/api-reference/beta/bounties/retrieve-bounty.md): Retrieves a bounty by ID. Authentication is optional: a request with no credential reads the bounty when it is publicly visible — published or completed, and not restricted to a private experience's members. Bounties outside the caller's scope, and bounties… - [Update Bounty](https://docs.whop.com/api-reference/beta/bounties/update-bounty.md): Updates a bounty. A published bounty accepts title, description, and country targeting while it is still open with nothing under review. A scheduled (not-yet-published) draft additionally accepts the reward, winner slots, and schedule. - [Cancel](https://docs.whop.com/api-reference/beta/bounties/cancel.md): Cancels a bounty. With no in-flight work, it cancels immediately and refunds the funder. Otherwise it stops new submissions and cancels once the in-flight work resolves and pays out. Repeating the request is a no-op. A bounty that already paid out every slot… - [List Public Submissions](https://docs.whop.com/api-reference/beta/bounties/list-public-submissions.md): Lists a bounty's publicly visible work — submitted, approved, and denied submissions in the reduced public shape. Authentication is optional; a bounty that is not publicly visible returns `404`. - [Retrieve Public Submission](https://docs.whop.com/api-reference/beta/bounties/retrieve-public-submission.md): Retrieves one of a bounty's publicly visible submissions in the reduced public shape — the read behind a shared proof link, whose submission is usually outside the bounty page's capped preview. Authentication is optional; a bounty that is not publicly… - [List Bounty Submissions](https://docs.whop.com/api-reference/beta/bounty-submissions/list-bounty-submissions.md): Lists bounty submissions visible to the credential — for a user token, the submissions they authored plus those on bounties they posted; for an account API key, the submissions on the account's bounties. For the anonymous view of one bounty's reviewed work,… - [Create Bounty Submission](https://docs.whop.com/api-reference/beta/bounty-submissions/create-bounty-submission.md): Creates a submission on a workforce bounty. Include a `deliverable` payload — any combination of links and uploaded files, with at least one of the two — and the submission goes straight to review; create is the only step. For `data_capture` bounties, omit… - [Retrieve Bounty Submission](https://docs.whop.com/api-reference/beta/bounty-submissions/retrieve-bounty-submission.md): Retrieves one bounty submission the credential can see — one the caller authored, or one on a bounty they posted or their account owns. Reading another member's work on an account's bounty takes `account_id`, the same way the list does. - [Cancel Bounty Submission](https://docs.whop.com/api-reference/beta/bounty-submissions/cancel-bounty-submission.md): Cancels the caller's own active attempt on a bounty and discards any accumulated capture clips. Only the worker who started the attempt can cancel it — account API keys cannot. - [Submit Bounty Submission](https://docs.whop.com/api-reference/beta/bounty-submissions/submit-bounty-submission.md): Submits a claimed attempt for review. A livestream attempt needs an ended proof stream and can attach an optional `deliverable` — links, files, and a caption in any combination; if the attempt already went to review when its stream ended, the payload… - [People](https://docs.whop.com/api-reference/beta/people/person.md): A Person is an identity-linked profile of a visitor or customer of an account, assembled from every [event](/api-reference/beta/events/event) the person generated — pixel page views, ad clicks, leads, identifies, and payments. Each profile carries the… - [List People](https://docs.whop.com/api-reference/beta/people/list-people.md): Lists the people (visitors and customers) of an account: the identity-linked person profiles aggregated from every pixel, payment, and platform event — identities, purchases and LTV, geo/device profile, traffic sources, and first/last marketing touches. - [Retrieve Person](https://docs.whop.com/api-reference/beta/people/retrieve-person.md): Retrieves one person for an account. The identifier can be a person ID (prefixed `prsn_`), a user ID (prefixed `user_`), an email address, or a phone number — merged people resolve to the surviving profile. - [Events](https://docs.whop.com/api-reference/beta/events/event.md): An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that… - [List Events](https://docs.whop.com/api-reference/beta/events/list-events.md): Lists identity-linked events, most recent first by default. Pass identifier for one person's journey, or omit it to list events for an account within an explicit time range. Pass direction=asc to read a journey forwards from where it starts. Events are… - [Create Event](https://docs.whop.com/api-reference/beta/events/create-event.md): Tracks a conversion or engagement event for an account. - [Retrieve the pulse feed](https://docs.whop.com/api-reference/beta/events/retrieve-the-pulse-feed.md): Returns a fully anonymized feed of recent platform-wide money movement, most recent first: purchases, affiliate commissions, card and ad spend, app revenue, off-platform sales, wallet deposits, card loads, claimed drops, transfers between accounts, and… - [Validate Pixel](https://docs.whop.com/api-reference/beta/events/validate-pixel.md): Checks whether the Whop pixel is installed for an account. Recent pixel events count as proof on their own, so an account that has sent data lately comes back installed without a `url`. Pass a `url` and events from that page settle it; conversion events are… - [Overview](https://docs.whop.com/api-reference/beta/ads/overview.md): Whop Ads runs paid ads on networks like Meta directly from your Whop account. You fund campaigns from your balance. Whop handles the ad account, review, launch, and billing. - [Ad](https://docs.whop.com/api-reference/beta/ads/ad.md): An Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. - [List Ads](https://docs.whop.com/api-reference/beta/ads/list-ads.md): Lists the ads for an account, with stats over the requested window. - [Create an Ad](https://docs.whop.com/api-reference/beta/ads/create-an-ad.md): 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. - [Retrieve an Ad](https://docs.whop.com/api-reference/beta/ads/retrieve-an-ad.md): Retrieves a single ad with stats over the requested window. - [Update an Ad](https://docs.whop.com/api-reference/beta/ads/update-an-ad.md): Updates an ad's editable fields. - [Delete an Ad](https://docs.whop.com/api-reference/beta/ads/delete-an-ad.md): Deletes an ad. - [Duplicate an Ad](https://docs.whop.com/api-reference/beta/ads/duplicate-an-ad.md): Copies the ad into its own ad group, or into target_ad_group_id (which must belong to the same account and be compatible with the ad). Copies keep the source ad's active/paused state. - [Pause an Ad](https://docs.whop.com/api-reference/beta/ads/pause-an-ad.md): Pauses an active ad. - [Unpause an Ad](https://docs.whop.com/api-reference/beta/ads/unpause-an-ad.md): Resumes a paused ad. - [Ad Updated](https://docs.whop.com/api-reference/beta/ads/ad-updated.md): Sent when an ad's status or delivery_status changes, including the in_review and rejected verdicts from ad review. previous_attributes carries the values they changed from; the payload carries no performance stats - [Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign.md): An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/ad-groups/ad-group) and ads. - [List Ad Campaigns](https://docs.whop.com/api-reference/beta/ad-campaigns/list-ad-campaigns.md): Lists the ad campaigns for an account, with stats over the requested window. - [Create an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/create-an-ad-campaign.md): Creates an ad campaign for an account. - [Retrieve an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/retrieve-an-ad-campaign.md): Retrieves a single ad campaign with stats over the requested window. - [Update an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/update-an-ad-campaign.md): Updates an ad campaign's editable fields (title, budget, schedule, bid strategy, special ad categories, and, before launch, budget type and budget optimization), and launches a draft campaign by setting status to active. Objective and desired cost per result… - [Delete an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/delete-an-ad-campaign.md): Deletes an ad campaign and archives it on the ad platform (cascades to ad groups and ads). - [Duplicate an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/duplicate-an-ad-campaign.md): Creates copies of the campaign in `duplicating` status and returns them; each copy transitions to `draft` once duplication completes. Poll each returned campaign until it leaves `duplicating` — a copy that could not be completed is deleted and returns 404. - [Pause an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/pause-an-ad-campaign.md): Pauses an active ad campaign. - [Retry a Failed Ad Campaign Payment](https://docs.whop.com/api-reference/beta/ad-campaigns/retry-a-failed-ad-campaign-payment.md): Retries billing for an ad campaign whose payment previously failed. - [Unpause an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/unpause-an-ad-campaign.md): Resumes a paused ad campaign. Requires an ads payment method on the account. - [Ad Campaign Payment failed](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign-payment-failed.md): Sent when an ad campaign's payment fails and its ads stop delivering. The payload carries no performance stats; read the campaign for those - [Ad Campaign Updated](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign-updated.md): Sent when an ad campaign's status or delivery_status changes. previous_attributes carries the values they changed from; the payload carries no performance stats - [Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/ad-group.md): An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads. - [List Ad Groups](https://docs.whop.com/api-reference/beta/ad-groups/list-ad-groups.md): Lists ad groups for the account, newest first. - [Create an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/create-an-ad-group.md): Creates an ad group (ad set) in a campaign. - [Retrieve an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/retrieve-an-ad-group.md): Retrieves a single ad group. - [Update an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/update-an-ad-group.md): Updates an ad group's editable fields. Only the keys you send are changed. - [Delete an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/delete-an-ad-group.md): Deletes an ad group. - [Duplicate an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/duplicate-an-ad-group.md): Creates copies of the ad group in `duplicating` status and returns them — into its own campaign, or into target_ad_campaign_id (which must belong to the same account and be compatible with the ad group's targeting and goals); each copy transitions to its… - [Pause an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/pause-an-ad-group.md): Pauses delivery of an ad group. - [Unpause an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/unpause-an-ad-group.md): Resumes delivery of a paused ad group. - [Estimate Ad Group Reach](https://docs.whop.com/api-reference/beta/ad-groups/estimate-ad-group-reach.md): Estimates how many people a draft targeting spec can reach, before an ad group is created. The body takes the same targeting fields as creating an ad group — `regions`, `demographics`, `detailed_targeting`, `audiences`, `languages`, and `devices` — and… - [Search Targeting Options](https://docs.whop.com/api-reference/beta/ad-groups/search-targeting-options.md): Searches the ad platform's targeting taxonomy for options to target an ad group with. Each result comes back in the exact shape the ad-group body accepts for its `type`, so it can be used in `detailed_targeting`, `regions`, or `languages` as-is. A blank… - [Audience](https://docs.whop.com/api-reference/beta/audiences/audience.md): An Audience is a reusable group of people to include or exclude when targeting ads. Build custom audiences from customer lists, Whop People data, or social engagement, and create lookalikes to reach people similar to an existing audience. - [Create](https://docs.whop.com/api-reference/beta/audiences/create-audience.md): Upload the customer CSV with [`POST /files`](/api-reference/files/create-file) on the Legacy API, then pass the returned `file_...` ID as `file_id`. - [List Audiences](https://docs.whop.com/api-reference/beta/audiences/list-audiences.md): List custom and lookalike audiences for an account. Pass `audience_id` to return a specific audience. - [Update Audience](https://docs.whop.com/api-reference/beta/audiences/update-audience.md): Renames an audience. For an audience built from People filters that keeps itself up to date, pass `filters` to replace them, which rebuilds membership immediately. Whether an audience auto refreshes is set when it is created. - [Delete Audience](https://docs.whop.com/api-reference/beta/audiences/delete-audience.md): Deletes an audience so it is no longer available for targeting. - [Add People](https://docs.whop.com/api-reference/beta/audiences/add-people.md): Adds users from a new CSV file to an existing uploaded custom audience. The file uses the audience's saved column mapping, processing happens in the background, and existing audience members remain unchanged. - [List Files](https://docs.whop.com/api-reference/beta/files/list-files.md): Returns the files with the given IDs, newest first — fetch a batch in one request instead of retrieving each file individually. Only files you created are returned; IDs that do not exist, or that another credential created, are omitted. A request for up to… - [Create File](https://docs.whop.com/api-reference/beta/files/create-file.md): Creates a file and returns a presigned destination to upload its bytes to. PUT the bytes to `upload_url` (single-part), or to each of `multipart_upload_urls` and then call Complete File Multipart Upload. Once the bytes land the file becomes `ready`, and its… - [Retrieve File](https://docs.whop.com/api-reference/beta/files/retrieve-file.md): Retrieves a file you uploaded — poll it after uploading the bytes to see `upload_status` become `ready`. Only the creator can retrieve a file this way; a file attached to another resource is read through that resource. - [Complete File Multipart Upload](https://docs.whop.com/api-reference/beta/files/complete-file-multipart-upload.md): Assembles the parts of a multipart upload after every part has been PUT to its presigned URL. Pass the `multipart_upload_id` from Create File and each part's `ETag` response header. For a step-by-step walkthrough of multipart uploads, see the [direct file… - [Media](https://docs.whop.com/api-reference/beta/media/media.md): A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files. - [Retrieve Media Asset](https://docs.whop.com/api-reference/beta/media/retrieve-media-asset.md): Retrieves a media asset by ID. Poll this while the asset is `processing`. - [Generate Media Asset](https://docs.whop.com/api-reference/beta/media/generate-media-asset.md): Starts an AI media generation job billed from the account's balance. Generation is asynchronous — poll `GET /media/{id}` until the asset is `ready`, then use `file.id` anywhere attachments are accepted. - [Social Account](https://docs.whop.com/api-reference/beta/social-accounts/social-account.md): A Social Account represents an external profile connected to a Whop account or user, such as a Facebook page or Instagram account. Connecting a social account lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity and promote its… - [List Social Accounts](https://docs.whop.com/api-reference/beta/social-accounts/list-social-accounts.md): Lists the social accounts linked to an account or user. - [Create a Social Account](https://docs.whop.com/api-reference/beta/social-accounts/create-a-social-account.md): Creates or returns a Whop-managed Facebook page or TikTok account for an account. - [Delete a Social Account](https://docs.whop.com/api-reference/beta/social-accounts/delete-a-social-account.md): Disconnects a social account from an account or user without deleting the underlying platform account. - [List Social Account Lead Forms](https://docs.whop.com/api-reference/beta/social-accounts/list-social-account-lead-forms.md): Lists the active lead (instant) forms that already exist on a connected Facebook page, so an ad can reuse one as its `lead_gen_form_id` instead of authoring a new form. Every active form comes back in a single response — the list is not paginated. - [List Social Account Posts](https://docs.whop.com/api-reference/beta/social-accounts/list-social-account-posts.md): Lists the existing posts of a connected Facebook page, Instagram account, or TikTok account. - [Connect a Social Account](https://docs.whop.com/api-reference/beta/social-accounts/connect-a-social-account.md): Starts an OAuth connection flow and returns an authorize_url where the user can connect a social account. - [App](https://docs.whop.com/api-reference/beta/apps/app.md): An App is software you build on Whop. It can be a hosted web app served at `.whop.site` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. - [List Apps](https://docs.whop.com/api-reference/beta/apps/list-apps.md): Lists apps on the Whop platform: the app store's live apps, or — with `account_id` and developer access to that account — every app the account owns. Requires authentication except for Whop's public app and website discovery lists. Public website discovery… - [Create App](https://docs.whop.com/api-reference/beta/apps/create-app.md): Registers a new app on the Whop developer platform. Apps provide custom experiences that can be added to products. - [Retrieve App](https://docs.whop.com/api-reference/beta/apps/retrieve-app.md): Retrieves an app by ID, claimed route, active verified custom hostname, or proxy domain id. Custom hostnames return 404 for inactive assignments, suspended accounts, or deleted apps. Credential fields (api_key, default_api_key, secrets) render `null` unless… - [Update App](https://docs.whop.com/api-reference/beta/apps/update-app.md): Updates the settings, metadata, or status of an app. Fields that are omitted keep their current value. - [Delete App](https://docs.whop.com/api-reference/beta/apps/delete-app.md): Deletes an app. The app stops resolving within seconds — a website's site stops serving, and any claimed subdomain is reserved for a month before it can be claimed again. - [Deploy App](https://docs.whop.com/api-reference/beta/apps/deploy-app.md): Builds the app's current source and ships it. Returns the run it started, so the caller can render progress from this response and then follow it on the app's `deployment` field. Only one deployment runs per app at a time — calling this while one is in… - [List App Logs](https://docs.whop.com/api-reference/beta/apps/list-app-logs.md): Lists a hosted app's server runtime logs, most recent first: console output, uncaught exceptions, and failed-request summaries captured on whop.site hosting. Logs are retained for 7 days. - [Update App Permissions](https://docs.whop.com/api-reference/beta/apps/update-app-permissions.md): Replaces the set of permissions the app requests from users when they install it. Requires a user session: the `developer:update_app_authorization` scope cannot be delegated to API keys. Sensitive permissions require step-up verification. - [Domain](https://docs.whop.com/api-reference/beta/domains/domain.md): A Domain is an account's claim to a hostname and its app assignment. Publish the returned ownership TXT and routing DNS records. Verification and certificate provisioning run automatically; unverified claims expire after 48 hours. Only verified domains with… - [List Domains](https://docs.whop.com/api-reference/beta/domains/list-domains.md): Lists the caller's domain claims and assignments. Filter by account, app, or lifecycle status. - [Create Domain](https://docs.whop.com/api-reference/beta/domains/create-domain.md): Creates an unverified claim and returns DNS instructions. A claim does not reserve the hostname globally. Publish its unique TXT record; ownership verification, DNS checks, and certificate provisioning run automatically. Unverified claims are deleted after… - [Retrieve Domain](https://docs.whop.com/api-reference/beta/domains/retrieve-domain.md): Retrieves the claim, app assignment, DNS instructions, and the latest hostname and certificate state. For domains still connecting, needing attention, or being deleted, requests an immediate background check. - [Update Domain](https://docs.whop.com/api-reference/beta/domains/update-domain.md): Reassigns a domain to another app in the same account or replaces its metadata. The hostname and owning account cannot be edited. - [Delete Domain](https://docs.whop.com/api-reference/beta/domains/delete-domain.md): Stops resolving the domain to its app and queues Cloudflare cleanup. The response is deleting; retrieve the resource until it is removed. - [App Build](https://docs.whop.com/api-reference/beta/app-builds/app-build.md): An App Build is a versioned artifact uploaded for an app — a hosted web archive, or an iOS/Android bundle. Builds start as drafts, go through review, and one approved build per platform is served to users as the production build. - [List App Builds](https://docs.whop.com/api-reference/beta/app-builds/list-app-builds.md): Returns a paginated list of build artifacts for an app, newest first, with optional platform, status, and creation-date filters. - [Create App Build](https://docs.whop.com/api-reference/beta/app-builds/create-app-build.md): Uploads a new build artifact for an app. Upload the file first (POST /files or a direct upload), then reference it here; iOS and Android take a .zip bundle, web takes a JavaScript file or a .zip archive of the hosted site. - [Retrieve App Build](https://docs.whop.com/api-reference/beta/app-builds/retrieve-app-build.md): Retrieves the details of an existing app build. - [Promote App Build](https://docs.whop.com/api-reference/beta/app-builds/promote-app-build.md): Promotes a draft or approved app build to production so it becomes the active version served to users. Draft builds enter review first. - [API Key](https://docs.whop.com/api-reference/beta/api-keys/api-key.md): An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist. - [List API Keys](https://docs.whop.com/api-reference/beta/api-keys/list-api-keys.md): Lists the API keys of an account or app, newest first. Responses never include the full secret — only its obfuscated form. - [Create API Key](https://docs.whop.com/api-reference/beta/api-keys/create-api-key.md): Creates an API key for an account or app. The response is the only place the full `secret_key` is returned — store it immediately. Requires a user session; API keys cannot manage API keys. - [Retrieve API Key](https://docs.whop.com/api-reference/beta/api-keys/retrieve-api-key.md): Retrieves an API key with its effective permission grants. The full secret is never returned — rotate the key if it was lost. - [Update API Key](https://docs.whop.com/api-reference/beta/api-keys/update-api-key.md): Updates an API key's name, permissions, API version, expiration, or IP allowlist. Fields that are omitted keep their current value; default keys cannot be modified. - [Delete API Key](https://docs.whop.com/api-reference/beta/api-keys/delete-api-key.md): Permanently revokes an API key; requests using its secret stop authenticating immediately. Default and agent-backend keys cannot be deleted. - [Rotate API Key](https://docs.whop.com/api-reference/beta/api-keys/rotate-api-key.md): Rotates the API key's secret, invalidating the previous secret immediately. The response is the only place the new `secret_key` is returned. - [List the Permission Catalog](https://docs.whop.com/api-reference/beta/api-keys/list-the-permission-catalog.md): Lists the catalog of permission actions that can be granted to users, apps, and API keys — the source for the dashboard's permission pickers. Small and returned in full on one page. - [List Api Logs](https://docs.whop.com/api-reference/beta/api-logs/list-api-logs.md): Lists the requests served by Whop's API with the account's API keys, newest first — every surface (GraphQL, REST, and native /api/v1), reads and failed requests included. - [Permission](https://docs.whop.com/api-reference/beta/permissions/permission.md): A Permission is one action, such as `stats:read`, paired with whether your credential is granted it on a given resource. It answers for whatever you authenticated with, so you can decide what to show or attempt instead of discovering a `403`. - [Check Permissions](https://docs.whop.com/api-reference/beta/permissions/check-permissions.md): Lists permission actions and whether the calling credential is granted each one for a resource. Answers for whichever identity authenticated the request — a user session, an OAuth token, or an account or app API key — so it never describes who else can reach… - [List Experiments](https://docs.whop.com/api-reference/beta/experiments/list-experiments.md): Lists experiments for one account with experiment:read permission. Omit account_id or pass internal to list internal experiments, which requires Whop internal access. - [Create Experiment](https://docs.whop.com/api-reference/beta/experiments/create-experiment.md): Creates a draft experiment for the specified account. Use internal for a Whop platform experiment. - [Retrieve Experiment](https://docs.whop.com/api-reference/beta/experiments/retrieve-experiment.md): Retrieves a single experiment or feature flag by its `expt_` id or flag_key handle. Requires the corresponding experiment permission on the owning account, or Whop internal access for internal experiments. - [Update Experiment](https://docs.whop.com/api-reference/beta/experiments/update-experiment.md): Updates the targeting rules, treatment allocation, metrics, or hypothesis of an existing experiment or feature flag. Weights and metrics can only grow, so enrolled users never change arms and an existing metric is never dropped. Lifecycle moves through the… - [Activate Experiment](https://docs.whop.com/api-reference/beta/experiments/activate-experiment.md): Starts (or resumes) an experiment or feature flag so evaluation begins serving it. Activating a draft stamps `started_at`; resuming a paused experiment keeps the original start. Only drafts and paused experiments can be activated. Requires the corresponding… - [End Experiment](https://docs.whop.com/api-reference/beta/experiments/end-experiment.md): Concludes the experiment and records required `findings`. Pass `winning_arm` to serve the winning treatment to everyone; omit it when control won. Ended experiments cannot restart, but may be ended again to correct the winner. Requires experiment:manage on… - [Pause Experiment](https://docs.whop.com/api-reference/beta/experiments/pause-experiment.md): Pauses an active experiment or feature flag: evaluation stops serving it and exposures stop flowing. Assignments are keyed on stable identity, so users return to their original arm when the experiment resumes. Requires the corresponding experiment permission… - [Evaluate Experiments](https://docs.whop.com/api-reference/beta/experiments/evaluate-experiments.md): Evaluates and records an exposure without requiring authentication. When credentials resolve, their authentication method, API key ID, and signed-in user ID are recorded on the exposure event. Pass subject for bucketing identity and account_id for experiment… - [Schema](https://docs.whop.com/api-reference/beta/ledger-stats/schema.md): No authentication required. Call this endpoint to discover all available filter values for the [time_series](/api-reference/beta/ledger-stats/time-series) endpoint with human-readable descriptions. - [Get Time Series](https://docs.whop.com/api-reference/beta/ledger-stats/time-series.md): Requires the `company:balance:read` permission. See [Permissions](/developer/guides/permissions). ## OpenAPI specs Machine-readable API definitions. - [Documented API (stable)](https://docs.whop.com/openapi/api-v1-stable.json) - [Documented API (experimental)](https://docs.whop.com/openapi/api-v1-native.yml) - [Ledger stats](https://docs.whop.com/openapi/ledger-stats.yaml) ## Optional End-user help center for Whop creators and customers — skippable when building against the API. - [Get Started with Whop](https://docs.whop.com/get-started.md): Whop is on a mission to deliver everyone a sustainable income. - [Refer Businesses to Whop](https://docs.whop.com/refer-businesses-to-whop.md): Earn 30% of Whop's profit from businesses you refer. - [Create a Whop](https://docs.whop.com/payments/create-a-whop.md): Learn how to create a whop for payment processing - [Launch Your Business](https://docs.whop.com/launch-your-business.md): Create an account on Whop and launch your business. - [Paid Groups](https://docs.whop.com/supported-business-models/paid-groups.md): Learn how to offer a paid group on Whop. - [Educational Programs](https://docs.whop.com/supported-business-models/educational-programs.md): Learn how to sell educational programs on Whop - [Coaches](https://docs.whop.com/supported-business-models/coaches.md): Learn how to launch your coaching business on Whop. - [Agencies](https://docs.whop.com/supported-business-models/agency-services.md): Learn how to launch and run your agency on Whop - [SaaS](https://docs.whop.com/supported-business-models/saas.md): Learn how to build and run your SaaS on Whop - [Newsletters](https://docs.whop.com/supported-business-models/newsletters.md): Learn how to launch and run your newsletter on Whop - [Events](https://docs.whop.com/supported-business-models/events.md): Learn how to launch and run your events on Whop - [Direct-to-consumer E-commerce](https://docs.whop.com/supported-business-models/dtc-ecommerce.md): Learn how to launch and run your e-commerce store on Whop - [Brick and Mortar](https://docs.whop.com/supported-business-models/brick-and-mortar.md): Learn how to launch and run your brick-and-mortar business on Whop - [Platforms](https://docs.whop.com/supported-business-models/platforms.md): Build a marketplace or platform with connected accounts and facilitate payments - [Whop Apps](https://docs.whop.com/whop-apps/what-are-whop-apps.md): Apps are the building blocks for your business. - [The Whop App Store](https://docs.whop.com/whop-apps/whop-app-store.md): Everything you need to know about the Whop App Store - [Consumer Apps](https://docs.whop.com/whop-apps/consumer-apps.md): Engage your audience with chat, courses, events, and social experiences - [Whop Support](https://docs.whop.com/get-help/whop-support.md): Get help from Whop support anytime, anywhere - [Whop Cards](https://docs.whop.com/whop-finance/cards.md): Spend your balance instantly and earn 5% cashback on select merchants - [Card Declines & Risk Rules](https://docs.whop.com/whop-finance/card-declines-and-risk-rules.md): Why Whop Card transactions get declined and the risk rules applied during authorization - [Blocked Categories & Merchants](https://docs.whop.com/whop-finance/blocked-categories-and-merchants.md): Merchant categories (MCCs) and merchants that Whop Cards block by default - [Create a Product](https://docs.whop.com/manage-your-business/products/create-product.md): Create a new product and set pricing, apps, and checkout options - [Manage Products](https://docs.whop.com/manage-your-business/products/manage-products.md): Learn how to manage and update products in your whop - [Add Apps](https://docs.whop.com/add-apps.md): Learn how to add apps to your whop - [Create a Waitlist](https://docs.whop.com/manage-your-business/products/create-waitlist.md): Have people join a waitlist before they can access your whop - [Free Trials](https://docs.whop.com/manage-your-business/products/free-trials.md): Learn how to set up a free trial for your whop - [Create a Product](https://docs.whop.com/payments/create-a-product.md): Learn how to set up products and pricing on Whop - [Create a Checkout Link](https://docs.whop.com/payments/create-checkout-link.md): Checkout links are the fastest way to accept payment. - [Promo Codes](https://docs.whop.com/manage-your-business/growth-marketing/promo-codes.md): Learn how to create and manage promo codes - [Tracking Links](https://docs.whop.com/manage-your-business/growth-marketing/tracking-links.md): Set up tracking links to see where your users are coming from - [Tracking Integrations](https://docs.whop.com/manage-your-business/growth-marketing/tracking-integrations.md): Set up external tracking integrations with analytics platforms. - [Support Chats](https://docs.whop.com/manage-your-business/growth-marketing/automated-messaging.md): Learn how to send automated marketing messages on Whop - [Whop Ads](https://docs.whop.com/manage-your-business/growth-marketing/ads.md): Run ads through Whop's agency accounts with first-party attribution from real buyer data - [Affiliate Program](https://docs.whop.com/manage-your-business/growth-marketing/affiliate-program.md): Learn how to set up an affiliate program for your whop - [Promote Your Business](https://docs.whop.com/affiliates/promote-your-business.md): Set up your affiliate program to automatically pay commissions when someone refers a new paying member to your whop - [Set Up Global Affiliates](https://docs.whop.com/affiliates/setup-global.md): Promote your product across Whop’s network of affiliates - [Set Up Custom Affiliates](https://docs.whop.com/affiliates/setup-custom.md): Promote your product across Whop’s network of affiliates - [Set Up Revenue Share](https://docs.whop.com/affiliates/setup-rev-share.md): Share revenue directly with partners per transaction using automatic Whop Payments payouts - [Be an Affiliate](https://docs.whop.com/affiliates/be-an-affiliate.md): Earn money by referring people to Whop offers using your affiliate link - [Analytics](https://docs.whop.com/manage-your-business/manage-business/analytics.md): Understand Whop's built-in analytics - [Integrations](https://docs.whop.com/manage-your-business/manage-business/integrations.md): Set up external tracking integrations — this content has moved. - [Upload Legal Documents](https://docs.whop.com/manage-your-business/manage-business/legal-documents.md): Learn how to upload legal documents and policies to your whop - [Team Management](https://docs.whop.com/manage-your-business/team-management/manage-team-roles.md): Add team members and manage who has access to your whop - [Pay Your Team](https://docs.whop.com/manage-your-business/team-management/pay-your-team.md): This content has moved to Manage payouts. - [Create a Checkout Link](https://docs.whop.com/manage-your-business/payment-processing/create-checkout-link.md): Checkout links are the fastest way to accept payment. - [Set Up Pricing](https://docs.whop.com/manage-your-business/payment-processing/set-up-pricing.md): Choose your pricing model and what members get in your whop - [Access Higher Checkout Links](https://docs.whop.com/manage-your-business/payment-processing/access-higher-checkout-links.md): Apply to create checkout links over $2,500 and accept higher-priced offers - [Embed Checkout](https://docs.whop.com/manage-your-business/payment-processing/embed-checkout.md): Learn how to embed Whop's checkout flow on your website - [Checkout Branding](https://docs.whop.com/manage-your-business/payment-processing/checkout-branding.md): Customize the look and feel of your checkout pages with button colors, fonts, and border styles - [Manage Users](https://docs.whop.com/manage-your-business/manage-payments/manage-users.md): Understand how to manage your users and make changes to their memberships - [Send an Invoice](https://docs.whop.com/manage-your-business/manage-payments/send-invoice.md): Learn how to create, send, and track invoices on Whop - [Refunds](https://docs.whop.com/manage-your-business/manage-payments/issuing-refunds.md): Learn how to refund your customers on Whop - [Resolution Center](https://docs.whop.com/manage-your-business/manage-payments/resolution-center.md): Manage refund requests before they turn into disputes - [Manage Disputes](https://docs.whop.com/manage-your-business/manage-payments/manage-disputes.md): Handle chargebacks and payment disputes with the Dispute fighter - [Send an Invoice](https://docs.whop.com/payments/send-an-invoice.md): Learn how to create, send, and track invoices on Whop - [Set Up Payouts](https://docs.whop.com/manage-your-business/manage-payouts/set-up-payouts.md): Learn how to set up payouts and withdraw your balance from Whop - [Payout Methods](https://docs.whop.com/manage-your-business/manage-payouts/payout-methods.md): Add and manage how you receive payouts - [Connected Accounts](https://docs.whop.com/manage-your-business/manage-payouts/connected-accounts.md): Manage connected accounts for payouts, split payments, and platforms - [Pay Your Team](https://docs.whop.com/manage-your-business/manage-payouts/pay-your-team.md): Learn how to pay your team members through Whop. - [Troubleshoot Payouts](https://docs.whop.com/manage-your-business/manage-payouts/troubleshoot-payouts.md): Fix failed payouts, check status, and withdraw affiliate earnings - [Set Up Payouts](https://docs.whop.com/payments/set-up-payouts.md): Learn how to set up payouts and withdraw your balance from Whop - [Local Payment Methods](https://docs.whop.com/payments-and-billing/local-payment-methods.md): Pay with regional, non-card options like bank transfers, iDEAL, crypto, and more, with no additional setup required. - [Tap to Pay on iPhone](https://docs.whop.com/payments-and-billing/tap-to-pay.md): Accept in-person contactless payments right on your iPhone with the Whop app. No card reader or extra hardware required. - [Financing Options](https://docs.whop.com/payments-and-billing/financing/all-bnpl-options.md): Buy now pay later options for your customers — Afterpay, Splitit, Klarna, Sezzle, ZipPay, PayPal, and more. - [Apply for Financing](https://docs.whop.com/payments-and-billing/financing/apply.md): See who is eligible and how to apply to offer buy now pay later payment options at checkout. - [Splitit Guide](https://docs.whop.com/payments-and-billing/financing/splitit-guide.md): Pay in monthly installments with no interest or credit check using your existing credit card. - [SeQura Guide](https://docs.whop.com/payments-and-billing/financing/sequra-guide.md): Let your Spanish customers split purchases into installments with SeQura - [Financing](https://docs.whop.com/payments/financing.md): Let customers split payments into monthly installments - [Fees](https://docs.whop.com/payments-and-billing/fees/fees.md): Whop aims to be the cheapest, most resilient place to accept pure payments. - [Taxes](https://docs.whop.com/payments-and-billing/fees/taxes.md): Who is responsible for tax on your Whop sales, the options you can choose from, and how to pick the right one - [In-app iOS Purchases](https://docs.whop.com/payments-and-billing/fees/in-app-ios-purchases.md): How Apple's fees affect pricing and payouts when customers buy through the Whop iOS app. - [Fees](https://docs.whop.com/fees.md): Whop aims to be the cheapest, most resilient place to accept pure payments. - [Adaptive Pricing](https://docs.whop.com/payments-and-billing/fees/adaptive-pricing.md): Show buyers prices in their local currency at checkout to lower fees, unlock local payment methods, and reduce declines. - [Billing Portal](https://docs.whop.com/payments-and-billing/manage-billing/billing-portal.md): A self-service portal for subscription management. - [Billing Portal](https://docs.whop.com/payments/billing-portal.md): This content has moved to Payments & billing. - [Payment Declines](https://docs.whop.com/payments-and-billing/payment-issues/payment-decline-reasons.md): How to resolve a failed payment - [Failed Subscription Payments](https://docs.whop.com/payments-and-billing/payment-issues/troubleshoot-failed-payments.md): When a subscription payment is unsuccessful, Whop, the merchant, and the customer can take steps to fix the failure. - [Payment Declines](https://docs.whop.com/payments/payment-declines.md): Learn how payment declines work and how to manage them - [Credit Card Disputes](https://docs.whop.com/payments/credit-card-disputes.md): Learn how credit card disputes work on Whop - [Dispute Fighter](https://docs.whop.com/payments/dispute-fighter.md): Manage and fight disputes from your dashboard - [Resolution Center](https://docs.whop.com/payments/resolution-center.md): Manage refund requests before they turn into disputes - [How to Find Your Purchase](https://docs.whop.com/memberships-and-access/accessing-your-purchase/how-to-find-your-purchase.md): Learn how to find your recent purchase from a creator on Whop. - [Duplicate Whop Accounts](https://docs.whop.com/memberships-and-access/accessing-your-purchase/duplicate-whop-accounts.md): What to do if you have more than one Whop account - [Transfer a Membership](https://docs.whop.com/memberships-and-access/accessing-your-purchase/transfer-a-membership.md): Learn how to move your membership or subscription to another Whop account. - [Access a Discord Server](https://docs.whop.com/memberships-and-access/access-discord-server/access-a-discord-server.md): Link your Discord account to Whop and join Discord servers included with your membership. - [Access Content on Mobile](https://docs.whop.com/memberships-and-access/access-discord-server/access-content-on-mobile.md): Use the Whop app or browser to access your memberships on your phone - [Cancel a Subscription](https://docs.whop.com/memberships-and-access/cancellations-and-refunds/cancel-a-subscription.md): Turn off automatic renewal for a subscription membership. - [Request a Refund](https://docs.whop.com/memberships-and-access/cancellations-and-refunds/request-a-refund.md): How to request a refund on a purchase you made on Whop - [Status of a Resolution Center Case](https://docs.whop.com/memberships-and-access/cancellations-and-refunds/status-of-resolution-center-case.md): Check the status of your refund or dispute case. - [Contact a Merchant](https://docs.whop.com/memberships-and-access/cancellations-and-refunds/contact-a-merchant.md): How to reach a creator about refunds and what to do if they're unresponsive. - [Content Rewards](https://docs.whop.com/memberships-and-access/third-party-apps/content-rewards.md): Earn rewards as a member or run creator campaigns with Content Rewards. - [Update Email](https://docs.whop.com/account-settings/personal-details/update-email.md): Change the email address connected to your Whop account from account settings. - [Update Phone Number](https://docs.whop.com/account-settings/personal-details/update-phone-number.md): Add or change the phone number saved on your Whop account from account settings. - [Update Username](https://docs.whop.com/account-settings/personal-details/update-username.md): Change your Whop display username from account settings. - [Hide Approximate Location](https://docs.whop.com/account-settings/personal-details/hide-approximate-location.md): Turn your approximate location, visible to other users, on or off from account settings. - [Enable 2FA](https://docs.whop.com/account-settings/account-security/enable-2fa.md): Add an extra layer of security to your Whop account by enabling two-factor authentication. - [Delete Your Account](https://docs.whop.com/account-settings/account-security/delete-your-account.md): Permanently delete your Whop user account from account settings. - [Prohibited Businesses](https://docs.whop.com/trust-and-safety/trust-safety-overview/what-is-not-allowed-on-whop.md): Prohibited and restricted categories, compliance obligations, and how Whop keeps the platform safe. - [Sanctioned Countries](https://docs.whop.com/trust-and-safety/trust-safety-overview/sanctioned-countries.md): List of countries Whop doesn't support due to international sanctions and regulatory restrictions. - [Community Guidelines](https://docs.whop.com/trust-and-safety/trust-safety-overview/community-guidelines.md) - [Prohibited Categories](https://docs.whop.com/trust-and-safety/trust-safety-overview/prohibited-categories.md) - [Payment Health](https://docs.whop.com/trust-and-safety/account-health/payment-health.md): Read your Payment health dashboard: your dispute rate, refund rate, why customers dispute, and the controls on your account - [Managing Dispute Rates](https://docs.whop.com/trust-and-safety/account-health/managing-dispute-rates.md): The concrete steps that bring a dispute rate down, and how to handle a negative balance - [Payment Controls](https://docs.whop.com/trust-and-safety/account-health/controls.md): The controls Whop places on accounts with elevated dispute rates, what each one does, and how they lift - [Reserves](https://docs.whop.com/trust-and-safety/account-health/reserves.md): Why Whop holds part of your balance in reserve, how each reserve type works, and when Whop releases held funds - [Account Suspensions](https://docs.whop.com/trust-and-safety/suspensions/account-suspensions.md): Understanding and resolving Whop account suspensions and bans, appeals, refunds, and funds handling. - [Report a Bad Actor](https://docs.whop.com/trust-and-safety/staying-safe/report-a-bad-actor.md): Report other users or businesses for harassment, hateful content, scams, or other Terms of Service violations. - [HubSpot](https://docs.whop.com/third-party-integrations/hubspot.md): Connect Whop to HubSpot. Sync products, generate checkout links from deals and contacts, and see payments natively in Commerce Hub. - [GoHighLevel](https://docs.whop.com/third-party-integrations/gohighlevel.md): Connect Whop payments to your GoHighLevel account. Install the payment connector, set Whop as your default provider, and start accepting payments. - [QuickBooks](https://docs.whop.com/third-party-integrations/quickbooks.md): Sync Whop payments, refunds, and payouts to QuickBooks Online automatically. Keep your books accurate without manual data entry. - [Xero](https://docs.whop.com/third-party-integrations/xero.md): Sync Whop payments, invoices, and payouts to Xero automatically. - [Zapier](https://docs.whop.com/third-party-integrations/zapier.md): Connect Whop to 7,000+ apps with Zapier. Automate triggers, actions, and conditional workflows.