# 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` (HTTP streaming) or `https://mcp.whop.com/sse` (SSE), authenticated with a Company or App API key, to list, create, and update resources.
- **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 <API_KEY>`. Company API keys access a single company's data; App API keys access companies 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
- **Stable vs Experimental:** the Stable API is production-ready. The Experimental (beta) API — pages under `/api-reference/beta` — may change without notice.
- **SDKs:** TypeScript `@whop/sdk`, Python `whop-sdk`, Ruby `whop_sdk`. Quickstart: https://docs.whop.com/developer/api/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.

- [CLI](https://docs.whop.com/developer/cli.md): Install the Whop CLI, sign in, and choose or create the business you want to manage from your terminal.
- [Quickstart](https://docs.whop.com/developer/api/quickstart.md): Create your Whop account, find the dashboard, get an API key, make your first SDK call, and test a webhook.
- [Getting started](https://docs.whop.com/developer/api/getting-started.md): Start programmatically accepting payments, paying other people, and building businesses.
- [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 safely by attaching an Idempotency-Key header, 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.

- [Accept payments](https://docs.whop.com/developer/guides/accept-payments.md): Accept one-time and recurring payments across 195 countries with 100+ payment methods
- [Save payment methods](https://docs.whop.com/developer/guides/save-payment-methods.md): Save customer payment methods to charge them later
- [Webhooks](https://docs.whop.com/developer/guides/webhooks.md): Receive payment, membership, and event notifications from Whop in realtime.
- [Enable Apple Pay](https://docs.whop.com/payments/apple-pay.md): Enable Apple Pay for your embedded checkout by verifying your domain
- [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): Returns a paginated list of dispute alerts for a company, with optional filtering by creation date.
- [Retrieve dispute alert](https://docs.whop.com/api-reference/dispute-alerts/retrieve-dispute-alert.md): Retrieves the details of an existing dispute alert.
- [DisputeAlert Created](https://docs.whop.com/api-reference/dispute-alerts/disputealert-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): Returns a paginated list of disputes for a company, with optional filtering by creation date. A dispute represents a chargeback or inquiry filed by a customer against a payment.
- [Retrieve dispute](https://docs.whop.com/api-reference/disputes/retrieve-dispute.md): Retrieves the details of an existing dispute.
- [Submit evidence](https://docs.whop.com/api-reference/disputes/submit-evidence.md): Submit a payment dispute to the payment processor for review. Once submitted, no further edits can be made.
- [Update evidence](https://docs.whop.com/api-reference/disputes/update-evidence.md): Update a dispute with evidence data to attempt to win the 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.
- [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, with optional filtering by creation date. A payment method is a stored representation of how a customer intends to pay, such as a card, bank account, or digital wallet.
- [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.
- [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): Returns a paginated list of payments for the actor in context, with optional filtering by product, plan, status, billing reason, currency, and creation date.
- [Create payment](https://docs.whop.com/api-reference/payments/create-payment.md): Charge an existing member off-session using one of their stored payment methods. You can provide an existing plan, or create a new one in-line. This endpoint will respond with a payment object immediately, but the payment is processed asynchronously in the…
- [Retrieve payment](https://docs.whop.com/api-reference/payments/retrieve-payment.md): Retrieves the details of an existing payment.
- [List fees](https://docs.whop.com/api-reference/payments/list-fees.md): Returns the list of fees associated with a specific payment, including platform fees and processing fees.
- [Refund payment](https://docs.whop.com/api-reference/payments/refund-payment.md): Issue 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): Retry 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): Void a payment that has not yet been settled. Voiding cancels the payment before it is captured by the payment processor.
- [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 Experimental 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 belonging to a company.
- [Create Product](https://docs.whop.com/api-reference/products/create-product.md): Creates a new product for a company.
- [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 the details of an existing product. This endpoint is publicly accessible.
- [Update Product](https://docs.whop.com/api-reference/products/update-product.md): Updates an existing product.
- [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): Returns a paginated list of promo codes belonging to a company, with optional filtering by product, plan, and status.
- [Create promo code](https://docs.whop.com/api-reference/promo-codes/create-promo-code.md): Create a new promo code that applies a discount at checkout. Can be scoped to specific products or plans.
- [Delete promo code](https://docs.whop.com/api-reference/promo-codes/delete-promo-code.md): Archive a promo code, preventing it from being used in future checkouts. Existing memberships are not affected.
- [Retrieve promo code](https://docs.whop.com/api-reference/promo-codes/retrieve-promo-code.md): Retrieves the details of an existing promo code.
- [Update promo code](https://docs.whop.com/api-reference/promo-codes/update-promo-code.md): Update whether a promo code can be used at checkout.
- [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): Returns a paginated list of refunds, with optional filtering by payment, company, user, and creation date.
- [Retrieve refund](https://docs.whop.com/api-reference/refunds/retrieve-refund.md): Retrieves the details of an existing 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): Returns a paginated list of resolution center cases, with optional filtering by company, status, and creation date.
- [Retrieve resolution center case](https://docs.whop.com/api-reference/resolution-center-cases/retrieve-resolution-center-case.md): Retrieves the details of an existing resolution center case.
- [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.
- [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, withdrawals, payout methods, deposits, swaps, cards, and topups.

- [Playground](https://docs.whop.com/developer/platforms/playground.md): Interactive playground for embedded payout components
- [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
- [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
- [Verification](https://docs.whop.com/developer/verification/overview.md): Verify your users' identities before they can receive payouts. One API call starts KYC — we handle 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 a provider needs additional information like a bank statement, tax ID, or business website.
- [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): Returns a paginated list of card transactions for a company.
- [Retrieve card transaction](https://docs.whop.com/api-reference/card-transactions/retrieve-card-transaction.md): Retrieves a single card transaction by ID.
- [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 company_id is provided, lists IPs currently linked to that company's ledger. When omitted, lists IPs linked to any ledger the actor can read (including child companies 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 Approved](https://docs.whop.com/api-reference/identity-profiles/identityprofile-approved.md): Sent when a identity profile is approved
- [IdentityProfile Needs action](https://docs.whop.com/api-reference/identity-profiles/identityprofile-needs-action.md): Sent when a identity profile is needs action
- [IdentityProfile Rejected](https://docs.whop.com/api-reference/identity-profiles/identityprofile-rejected.md): Sent when a identity profile is rejected
- [IdentityProfile Updated](https://docs.whop.com/api-reference/identity-profiles/identityprofile-updated.md): Sent when a identity profile is updated
- [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 Experimental 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): Retrieves the details of an existing verification.
- [Verification Succeeded](https://docs.whop.com/api-reference/verifications/verification-succeeded.md): Sent when a verification is succeeded
- [Withdrawal](https://docs.whop.com/api-reference/withdrawals/withdrawal.md): A withdrawal represents a request to transfer funds from a ledger account to an external payout method.
- [List withdrawals](https://docs.whop.com/api-reference/withdrawals/list-withdrawals.md): Returns a paginated list of withdrawals for a company, with optional sorting and date filtering.
- [Create withdrawal](https://docs.whop.com/api-reference/withdrawals/create-withdrawal.md): Creates a withdrawal request for a ledger account
- [Retrieve withdrawal](https://docs.whop.com/api-reference/withdrawals/retrieve-withdrawal.md): Retrieves the details of an existing withdrawal.
- [Generate PDF](https://docs.whop.com/api-reference/withdrawals/generate-pdf.md): Generates a withdrawal PDF invoice and returns a temporary download URL.
- [Withdrawal Created](https://docs.whop.com/api-reference/withdrawals/withdrawal-created.md): Sent when a withdrawal is created
- [Withdrawal Updated](https://docs.whop.com/api-reference/withdrawals/withdrawal-updated.md): Sent when a withdrawal is updated

## Ads

Create and manage ad campaigns, ad groups, and ads; pull ad reports; and track conversions.

- [Ad Report](https://docs.whop.com/api-reference/ad-reports/ad-report.md): An ads performance report. Always returns a summary. The `granularity` field contains a per-bucket time series when the `granularity` arg is set; the `breakdown` field contains per-entity rows when the `breakdown` arg is set.
- [Retrieve ad report](https://docs.whop.com/api-reference/ad-reports/retrieve-ad-report.md): Performance report for a company, ad campaigns, ad groups, or ads. Always returns aggregate `summary` totals summed across the scope. Set `granularity` to additionally get a time series, or set `breakdown` (`campaign`/`ad_group`/`ad`) to additionally get…

## 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): Returns a paginated list of members for a company, with extensive filtering by product, plan, status, access level, and more.
- [Retrieve member](https://docs.whop.com/api-reference/members/retrieve-member.md): Retrieves the details of an existing member.
- [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): Returns a paginated list of memberships, with optional filtering by product, plan, status, and user.
- [Retrieve membership](https://docs.whop.com/api-reference/memberships/retrieve-membership.md): Retrieves the details of an existing membership.
- [Update membership](https://docs.whop.com/api-reference/memberships/update-membership.md): Update a membership's metadata or other mutable properties.
- [Add free days membership](https://docs.whop.com/api-reference/memberships/add-free-days-membership.md): Add free days to extend a membership's current billing period, expiration date, or Stripe trial.
- [Cancel membership](https://docs.whop.com/api-reference/memberships/cancel-membership.md): Cancel a membership either immediately or at the end of the current billing period. Immediate cancellation revokes access right away.
- [Pause membership](https://docs.whop.com/api-reference/memberships/pause-membership.md): Pause a membership's recurring payments. The customer retains access but will not be charged until the membership is resumed.
- [Resume membership](https://docs.whop.com/api-reference/memberships/resume-membership.md): Resume a previously paused membership's recurring payments. Billing resumes on the next cycle.
- [Resync access membership](https://docs.whop.com/api-reference/memberships/resync-access-membership.md): Re-run access fulfillment for a membership. Recomputes the member's content access on Whop, re-validates their Discord link (re-adding them to the server and re-assigning roles if needed), and re-fulfills TradingView indicator access. Telegram access is…
- [Uncancel membership](https://docs.whop.com/api-reference/memberships/uncancel-membership.md): Reverse a pending cancellation for a membership that was scheduled to cancel at period end.
- [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, with optional filtering by payment, company, or user.
- [Create shipment](https://docs.whop.com/api-reference/shipments/create-shipment.md): Create a new shipment with a tracking code for a specific payment within a company.
- [Retrieve shipment](https://docs.whop.com/api-reference/shipments/retrieve-shipment.md): Retrieves the details of an existing shipment.

## Chat & engagement

Build chat and community features: channels, direct messages, messages, forums, reactions, notifications, and support channels.

- [Playground](https://docs.whop.com/developer/guides/chat/playground.md): Interactive playground for embedded chat components
- [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, realtime updates, media uploads and UI.
- [Authentication](https://docs.whop.com/developer/guides/chat/authentication.md): Authenticate users for embedded chat with company-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.
- [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 company
- [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 a company_id to post to a company'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
- [Create notification](https://docs.whop.com/api-reference/notifications/create-notification.md): Send a push notification to users in an experience or company team. The notification is processed asynchronously and supports targeting specific users.
- [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, companies, and connected social accounts.

- [Authorized User](https://docs.whop.com/api-reference/authorized-users/authorized-user.md): A user who has been granted administrative access to manage a company's dashboard and settings.
- [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.
- [Company](https://docs.whop.com/api-reference/companies/company.md): A company is a seller on Whop. Companies own products, manage members, and receive payouts.
- [List companies](https://docs.whop.com/api-reference/companies/list-companies.md): Returns a paginated list of companies. When parent_company_id is provided, lists connected accounts under that platform. When omitted, lists companies the current user has access to.
- [Create company](https://docs.whop.com/api-reference/companies/create-company.md): Create a new company. Pass parent_company_id to create a connected account under a platform, or omit it to create a company for the current user.
- [Retrieve company](https://docs.whop.com/api-reference/companies/retrieve-company.md): Retrieves the details of an existing company.
- [Update company](https://docs.whop.com/api-reference/companies/update-company.md): Update a company's title, description, logo, and other settings.
- [Create child company API key](https://docs.whop.com/api-reference/companies/create-child-company-api-key.md): Create an API key for a connected account (child company) owned by a parent company.
- [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 Experimental API Reference.

## AI & MCP

Connect AI agents to Whop over MCP, work with AI chats, and generate AI media (videos and images).

- [AI and MCP](https://docs.whop.com/developer/guides/ai_and_mcp.md): Build Whop apps with AI assistance using Model Context Protocol
- [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 company context.

## Apps & developer tools

Build Whop apps and embed them: app views, permissions, OAuth, iframe, app builds, files, access tokens, and webhooks.

- [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 our 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 + 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 company.
- [Affiliates](https://docs.whop.com/developer/guides/affiliates.md): Create affiliate records, assign per-plan or rev-share commission overrides, and track referral earnings.
- [Wallet Stats API](https://docs.whop.com/developer/guides/ledger-stats.md): Query aggregated financial time-series from your Fragment ledger
- [Install the Whop pixel](https://docs.whop.com/developer/guides/pixel.md): Add the whop.track snippet to your funnel to measure page views, identify visitors, and attribute conversions from first-party data.
- [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 company_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.
- [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.
- [Update requested permissions](https://docs.whop.com/api-reference/apps/update-requested-permissions.md): Updates the permission requirements for an app
- [Retrieve App](https://docs.whop.com/api-reference/apps/retrieve-app.md): Retrieves an app by ID, claimed route, or proxy domain id. Credential fields (api_key, default_api_key, secrets) render `null` unless the caller has the corresponding developer permission on the owning company.
- [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): Create a new file record and receive a presigned URL for uploading content to S3.
- [Retrieve file](https://docs.whop.com/api-reference/files/retrieve-file.md): Retrieves the details of an existing file.
- [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 a company, 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, API 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.
- [List deliveries](https://docs.whop.com/api-reference/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.

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

- [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. Bounties outside the caller's scope return `404`.

## SDKs & embedded elements

Embed Whop UI: the checkout embed, the WhopElements entry point, and payouts, chat, and wallet elements, with shared types and styling.

- [Embed checkout](https://docs.whop.com/payments/checkout-embed.md): Learn how to embed Whop's checkout flow on your website
- [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
- [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

## Experimental API

The Experimental (beta) API — endpoints under /api-reference/beta. Opt-in and may change without notice; pin a version with the Api-Version-Date header. Prefer the stable resources in the sections above for production.

- [Overview](https://docs.whop.com/api-reference/beta/overview.md): What the API does, how requests work, and a map of every resource.
- [Quickstart](https://docs.whop.com/api-reference/beta/quickstart.md): Make your first call in about a minute, then create a checkout link that takes real payments.
- [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.
- [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; business account API keys return the requesting business account and its connected accounts.
- [Create Account](https://docs.whop.com/api-reference/beta/accounts/create-account.md): Creates an account. User tokens create business accounts; business 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…
- [Retrieve Account](https://docs.whop.com/api-reference/beta/accounts/retrieve-account.md): Retrieves a single account visible to the credential, including its crypto wallet.
- [Update Account](https://docs.whop.com/api-reference/beta/accounts/update-account.md): Updates an account. User tokens can update business accounts; business account API keys can update connected accounts.
- [Register LLC](https://docs.whop.com/api-reference/beta/accounts/register-llc.md): Starts an LLC formation for a business account. On submission, the application is validated and the response returns a hosted checkout URL. Once paid, the filing is submitted. Track progress through the account's…
- [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_payment_methods` always requires a `primary` entry. `backup` is optional and any pairing is allowed — two cards,…
- [List Recommended Actions](https://docs.whop.com/api-reference/beta/accounts/list-recommended-actions.md): Lists the recommended actions computed for the account — the same set embedded on the account resource, served on their own so a caller can fetch just the recommendations.
- [Retrieve Requesting Account](https://docs.whop.com/api-reference/beta/accounts/retrieve-requesting-account.md): Retrieves the business account associated with the current business account API key.
- [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's public profile by user_ tag, username, or 'me'.
- [Update User](https://docs.whop.com/api-reference/beta/users/update-user.md): Updates a 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…
- [Update Current User](https://docs.whop.com/api-reference/beta/users/update-current-user.md): Updates the authenticated user's global profile, or their profile override for an account when account_id is given. Not available to API keys.
- [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 user to an account's team with a system role. If the user has not yet accepted, an invitation is sent instead and the response is `202` with `{ "object": "team_member_invite", "invitation_sent": true }`. If the user already has a pending invite, the…
- [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. The account owner cannot be removed.
- [List Webhooks](https://docs.whop.com/api-reference/beta/webhooks/list-webhooks.md): Returns a paginated list of webhook endpoints configured for a company, 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, API 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.
- [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 over a time range.
- [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, withdrawal, 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`…
- [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 the given ledger account over the requested date range, or a platform-wide report when account_id is `global` (internal admin access only). Dates are Unix timestamps in…
- [List Financial Activity](https://docs.whop.com/api-reference/beta/ledgers/list-financial-activity.md): Returns a paginated activity feed for one account or user, derived from ledger lines with typed resource and source objects for presentation. Pass exactly one of `account_id` (a `biz_` identifier) or `user_id` (a `user_` identifier). Filter by line type,…
- [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 payouts (withdrawal requests) for an account or user, most recent first. Pass exactly one of account_id (a biz_ identifier) or user_id (a user_ identifier). The saved payout method on each payout additionally requires the payout:destination:read scope…
- [Create Payout](https://docs.whop.com/api-reference/beta/payouts/create-payout.md): Creates a payout from a stablecoin account to a saved payout method. The account's funds move from its stablecoin balance to an external bank account, wallet, or crypto address. Accounts that pay out from a fiat balance use POST /withdrawals. Requires the…
- [List Payout Methods](https://docs.whop.com/api-reference/beta/payouts/list-payout-methods.md): Lists the saved payout methods (bank accounts, digital wallets, crypto addresses) that an account or user can withdraw to, most recently added first. Pass exactly one of account_id (a biz_ identifier) or user_id (a user_ identifier). Pass an amount to…
- [Create Payout Method](https://docs.whop.com/api-reference/beta/payouts/create-payout-method.md): Saves a new payout method for an account or user by submitting the destination's required fields, keyed by field id (list them with GET /payouts/methods?destination_id=...). Sensitive values are vaulted in transit and never stored raw; a Basis Theory token…
- [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 Cards](https://docs.whop.com/api-reference/beta/cards/list-cards.md): Lists issued Whop virtual cards for an account or user, including pending invitation cards that have not been issued by the card provider yet. Pass exactly one of account_id (a biz_ identifier) or user_id (a user_ identifier). Non-owner team members only see…
- [Create Card](https://docs.whop.com/api-reference/beta/cards/create-card.md): Issues a virtual card. For an individual (consumer) card issuing account, the card is issued to the account's own cardholder. For a company (business) card issuing account, pass assigned_user_id to issue the card to a company member; if that member is not…
- [Retrieve Card](https://docs.whop.com/api-reference/beta/cards/retrieve-card.md): Retrieves a single card by its icrd_ identifier, including its secrets (full card number, CVC, and cardholder name) for active cards. The card PIN is included only when the request is authenticated as the user the card is assigned to.
- [Update Card](https://docs.whop.com/api-reference/beta/cards/update-card.md): Updates an issued card. All fields are optional; only the fields you pass are changed. Updates the card name, billing address, and spending limits in one call, sets a new PIN, freezes or unfreezes the card, or cancels it. Pass canceled: true alone to cancel…
- [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 ledger transfers for an account. You must specify an origin_id or a destination_id.
- [Create Transfer](https://docs.whop.com/api-reference/beta/transfers/create-transfer.md): Moves funds out of an account. `type` selects the kind of movement (default `ledger`): `ledger` transfers credit between two ledger accounts and returns a Transfer; `wallet_send` sends USDT from the origin account's Ethereum wallet to a recipient;…
- [Retrieve Transfer](https://docs.whop.com/api-reference/beta/transfers/retrieve-transfer.md): Retrieves a ledger transfer by ID.
- [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): Resolves a deposit destination and returns the on-chain addresses that can fund it. No authentication is required; any business can be resolved by its account ID. A caller authenticated as a user can additionally resolve their own user account.
- [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): Lists the account's swaps. Currently returns the in-flight or most recent swap, so zero or one rows.
- [Create Swap](https://docs.whop.com/api-reference/beta/swaps/create-swap.md): Executes a swap from the account's wallet. Runs asynchronously; poll GET /swaps/{id} for status.
- [Retrieve Swap](https://docs.whop.com/api-reference/beta/swaps/retrieve-swap.md): Returns the status of a specific swap, by the id returned from POST /swaps.
- [Create Swap Quote](https://docs.whop.com/api-reference/beta/swaps/create-swap-quote.md): Returns a stateless swap price preview. No funds move and nothing is persisted.
- [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.
- [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 belonging to a company.
- [Create Product](https://docs.whop.com/api-reference/beta/products/create-product.md): Creates a new product for a company.
- [Retrieve Product](https://docs.whop.com/api-reference/beta/products/retrieve-product.md): Retrieves the details of an existing product. This endpoint is publicly accessible.
- [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.
- [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 is read-only — 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 belonging to an account, with optional filtering by visibility, type, release method, and product.
- [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.
- [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.
- [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.
- [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.
- [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. Bounties outside the caller's scope return `404`.
- [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.
- [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.
- [Create Bounty Submission](https://docs.whop.com/api-reference/beta/bounty-submissions/create-bounty-submission.md): Creates a submission on a workforce bounty. For `content_url` and `media` bounties, include the matching `deliverable` payload and the submission goes straight to review — create is the only step. For `data_capture` bounties, omit the deliverable: this…
- [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.
- [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 once its server-accumulated proof is ready. A data capture attempt needs enough validated clip time to meet the bounty's required capture duration. Only the worker who started the attempt can submit it — account API keys…
- [People](https://docs.whop.com/api-reference/beta/people/person.md): A Person represents a visitor or customer of an account, assembled from [pixel events](/api-reference/beta/events/event) and purchase activity — ad clicks, storefront visits, and checkouts.
- [List People](https://docs.whop.com/api-reference/beta/people/list-people.md): Lists the people (visitors and customers) of an account, aggregated from pixel events. The account is inferred from an account API key; other credentials must pass account_id.
- [Retrieve Person](https://docs.whop.com/api-reference/beta/people/retrieve-person.md): Retrieves one person for an account, aggregated from pixel events.
- [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. Pass identifier for one person's journey, or omit it to list events for an account within an explicit time range. Events are shaped like the POST /events intake: attribution in context, identity in user.
- [Create Event](https://docs.whop.com/api-reference/beta/events/create-event.md): Tracks a conversion or engagement event for an account.
- [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.
- [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. Returns true on success.
- [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 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 optimization), and launches a draft campaign by setting status to active. Objective, budget type 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). Returns true on success.
- [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.
- [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. Returns true on success.
- [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 represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences.
- [Create Audience](https://docs.whop.com/api-reference/beta/audiences/create-audience.md): Pass a direct upload ID from the standard media upload endpoint as `file_id`.
- [List Audiences](https://docs.whop.com/api-reference/beta/audiences/list-audiences.md): Lists uploaded customer-list audiences for an account. Pass `audience_id` to return a specific audience.
- [Delete Audience](https://docs.whop.com/api-reference/beta/audiences/delete-audience.md): Deletes an audience so it is no longer available for targeting.
- [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 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 or Instagram 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 `<route>.whop.app` 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.
- [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, or proxy domain id. Credential fields (api_key, default_api_key, secrets) render `null` unless the caller has the corresponding developer permission on the owning company.
- [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.
- [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.app 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.
- [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 a company 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 a company 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, 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 Permissions](https://docs.whop.com/api-reference/beta/api-keys/list-permissions.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.

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

- [What is 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): If you refer a business to Whop, you'll earn a 30% commission on their revenue.
- [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
- [DTC Ecommerce](https://docs.whop.com/supported-business-models/dtc-ecommerce.md): Learn how to launch and run your ecommerce 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
- [Whop support](https://docs.whop.com/get-help/whop-support.md): Get help from Whop's support team 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
- [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
- [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
- [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
- [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
- [Local payment methods](https://docs.whop.com/payments-and-billing/local-payment-methods.md): Pay with regional, non-card payment options like ACH, iDEAL, SEPA, crypto, and more, with no additional setup 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, 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
- [Fees](https://docs.whop.com/payments-and-billing/fees/fees.md): We want 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.
- [Billing portal](https://docs.whop.com/payments-and-billing/manage-billing/billing-portal.md): A self-service portal for subscription management.
- [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.
- [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 auto-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 we keep the platform safe.
- [Sanctioned countries](https://docs.whop.com/trust-and-safety/trust-safety-overview/sanctioned-countries.md): List of countries Whop does not support due to international sanctions and regulatory restrictions.
- [Manage payment account health](https://docs.whop.com/trust-and-safety/account-health/understanding-risk-score.md): Understand risk scores, disputes, reserves, and how to keep your payments account healthy.
- [Business health and dispute monitoring](https://docs.whop.com/trust-and-safety/account-health/business-health.md): Understand why controls are placed on high-dispute accounts, and learn exactly how to lower your dispute rate.
- [Managing dispute rates](https://docs.whop.com/trust-and-safety/account-health/managing-dispute-rates.md): Keep your dispute rate low and handle negative balances
- [Reserves](https://docs.whop.com/trust-and-safety/account-health/reserves.md): When and why Whop holds a portion of your balance in reserve
- [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 TOS 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.