# Whop Docs: For Developers API Reference Current API > 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. ## Current API - [For Developers / API Reference / Current API / Core Resources (79 pages)](https://docs.whop.com/_llms/for-developers/api-reference/current-api/core-resources.md): Documentation for For Developers / API Reference / Current API / Core Resources. ### Introduction - [Overview](https://docs.whop.com/api-reference/beta/overview.md): What the API does, how requests work, and a map of every resource. - [API Stability](https://docs.whop.com/api-reference/stability.md): Which state every Current API resource is in: current, available on both surfaces, or Legacy-only, and where to build. ### Reference - [API Versions](https://docs.whop.com/developer/api/versioning.md): Pin your requests to a dated API version so changes to the API never break your integration. - [Idempotent Requests](https://docs.whop.com/developer/api/idempotency.md): Retry POST requests with an idempotency key, so a request is never executed twice. ### Webhooks & Events - [Webhooks](https://docs.whop.com/developer/guides/webhooks.md): Receive payment, membership, and event notifications from Whop in realtime. ### Notifications #### Notifications - [List Notifications](https://docs.whop.com/api-reference/beta/notifications/list-notifications.md): Lists the authenticated user's notifications, newest first. Requires a user credential — an account API key has no notification feed. Without filters the feed spans every experience the user belongs to plus the teams they are a member of. The `after` cursor is a notification `id` from a previous res… - [Retrieve Notification](https://docs.whop.com/api-reference/beta/notifications/retrieve-notification.md): Retrieves a single notification by id — either an `id` returned by List Notifications, or the ephemeral id delivered with a push/websocket event. Requires a user credential. - [List Notification Badges](https://docs.whop.com/api-reference/beta/notifications/list-notification-badges.md): Lists the authenticated user's per-experience unread badge state. Requires a user credential. Returns one row per experience the user belongs to (or per requested experience). - [List Notification Topics](https://docs.whop.com/api-reference/beta/notifications/list-notification-topics.md): Lists the platform's visible notification topics — the categories users can set notification preferences on. App-created topics are internal and not returned. - [Send Notification](https://docs.whop.com/api-reference/beta/notifications/send-notification.md): Queues a notification to every user of an experience or to an account's team, processed asynchronously. Every send is attributed to an app: use an app API key, or a credential acting on behalf of an app. Narrow the audience with `user_ids` to send a mention. - [Mark Notifications Read](https://docs.whop.com/api-reference/beta/notifications/mark-notifications-read.md): Marks the authenticated user's notifications as read: one experience's (`experience_id`) or everything (`all: true`) — exactly one of the two. Requires a user credential. Responds with the refreshed badge rows for the affected scope. ### Payments #### Payments - [Payments](https://docs.whop.com/api-reference/beta/payments/payment.md) - [List Payments](https://docs.whop.com/api-reference/beta/payments/list-payments.md): Lists payments, newest first. By default, returns account sales: a company credential's own account, or for a user every account they can read payments for. Set `mode=user_sales` to list only the sales received by the signed-in user's primary ledger account, without a company. This mode requires the… - [Retrieve Payment](https://docs.whop.com/api-reference/beta/payments/retrieve-payment.md): Returns one payment, including every purchased line item with its quantity and subtotal. Related records are ids — resolve a variant, membership, member or shipment on its own endpoint, and list this payment's refunds, disputes or Resolution Center cases with `?payment_id=`. - [List Payment Fees](https://docs.whop.com/api-reference/beta/payments/list-payment-fees.md): Returns the fee breakdown of one payment — Whop's fee, processing, affiliate and other lines — each in the currency it was collected in and converted to the payment's settlement currency. The list is complete in one page. - [Retrieve Payment Status](https://docs.whop.com/api-reference/beta/payments/retrieve-payment-status.md): Retrieves how far a payment has got and what the buyer must do next, if anything. A payment is collected in the background, so poll this rather than reading the create response. Accepts either a secret key or the payment's own `client_secret`, so the surface collecting the payment can poll it direct… - [Create Payment](https://docs.whop.com/api-reference/beta/payments/create-payment.md): Charges a buyer for one or more variants. Pass a payment method already on file (`member_id` and `payment_method_id`), or a `confirmation_token` describing a method the buyer just supplied. Collection runs in the background: the response is the payment as created, not its outcome — poll Retrieve sta… - [Capture Payment](https://docs.whop.com/api-reference/beta/payments/capture-payment.md): Captures the full amount of a card payment created with `capture: false`. The payment must still be in `requires_capture` before `capture_expires_at`. Partial capture, multiple captures, capturing more than the authorized amount, and tips are not supported. - [Refund Payment](https://docs.whop.com/api-reference/beta/payments/refund-payment.md): Issues a full or partial refund for a payment. The refund is processed through the original payment processor and the membership status is updated accordingly. - [Resume a Parked Renewal](https://docs.whop.com/api-reference/beta/payments/resume-a-parked-renewal.md): Starts a fresh on-session attempt with the saved card for a subscription renewal that is waiting on the customer to authenticate; the bank's step then arrives in `next_action` on the following status reads. Only the payment's own customer may call it — with the payment's `client_secret` or their own… - [Retry Payment](https://docs.whop.com/api-reference/beta/payments/retry-payment.md): Retries a failed or pending payment. This re-attempts the charge using the original payment method and variant details. - [Void Payment](https://docs.whop.com/api-reference/beta/payments/void-payment.md): Voids or cancels an eligible payment. The request is rejected if the payment is no longer eligible. Some processors confirm the release of a card authorization asynchronously: the payment is then returned still `authorized`, and a `payment.canceled` webhook follows once the hold is released. - [Update Payment](https://docs.whop.com/api-reference/beta/payments/update-payment.md): Updates a payment's `shipping_address` or `return_url`. Send the complete `shipping_address`, because it replaces the existing address and any field you leave out is cleared. - [Update Payment Return URL](https://docs.whop.com/api-reference/beta/payments/update-payment-return-url.md): Changes where the buyer lands after completing an off-site step, up until they return. Accepts either a secret key or the payment's own `client_secret`, so the surface that knows the final destination can set it. - [Payment authorized](https://docs.whop.com/api-reference/beta/payments/payment-authorized.md): Sent when a payment is authorized - [Payment canceled](https://docs.whop.com/api-reference/beta/payments/payment-canceled.md): Sent when a payment is canceled - [Payment created](https://docs.whop.com/api-reference/beta/payments/payment-created.md): Sent when a payment is created - [Payment failed](https://docs.whop.com/api-reference/beta/payments/payment-failed.md): Sent when a payment is failed - [Payment pending](https://docs.whop.com/api-reference/beta/payments/payment-pending.md): Sent when a payment is pending - [Payment Requires Action](https://docs.whop.com/api-reference/beta/payments/payment-requires-action.md): Sent when the bank asks the buyer to verify an off-session charge, such as a subscription renewal or a saved-card payment your server made. `data.recovery_url` is the Whop link where the buyer signs in and completes 3D Secure; the event is only sent while that link exists, so it is null only when yo… - [Payment succeeded](https://docs.whop.com/api-reference/beta/payments/payment-succeeded.md): Sent when a payment is succeeded #### Payment Quotes - [Payment Quotes](https://docs.whop.com/api-reference/beta/payment-quotes/payment-quote.md) - [Retrieve Payment Quote](https://docs.whop.com/api-reference/beta/payment-quotes/retrieve-payment-quote.md): Retrieves a payment quote, including the payment holding it (`payment_id`, whose `status` says whether it collected) and when it expires. - [Create Payment Quote](https://docs.whop.com/api-reference/beta/payment-quotes/create-payment-quote.md): Prices a purchase the way a payment for it will be charged, for a buyer located by the shipping address, then the billing address, then the IP address you pass. The body is the `PaymentInput` a payment takes plus where the buyer is (`address`, `shipping_address`, `tax_ids`, `ip_address`); a seller t… #### Refunds - [List Refunds](https://docs.whop.com/api-reference/beta/refunds/list-refunds.md): Lists refunds, newest first. Without filters this is every refund the caller can read; narrow it to one payment with `payment_id`, one account with `account_id`, or one buyer with `user_id`. - [Retrieve Refund](https://docs.whop.com/api-reference/beta/refunds/retrieve-refund.md): Returns one refund. #### Confirmation Tokens - [Confirmation Token](https://docs.whop.com/api-reference/beta/confirmation-tokens/confirmation-token.md) - [Retrieve Confirmation Token](https://docs.whop.com/api-reference/beta/confirmation-tokens/retrieve-confirmation-token.md): Retrieves a token's payment method and billing details — never the underlying payment credential. Public and rate-limited: the account_id query param must match the account the token was minted for. A bearer credential with payment:basic:read on that account also receives the collected billing addre… #### Setup Intents - [Setup Intent](https://docs.whop.com/api-reference/beta/setup-intents/setup-intent.md) - [List Setup Intents](https://docs.whop.com/api-reference/beta/setup-intents/list-setup-intents.md): Lists setup intents newest first. An account API key lists its own account; a user token lists every account it can read, or one account with `account_id`. `client_secret` is always null on list rows — retrieve the setup intent for it. - [Retrieve Setup Intent](https://docs.whop.com/api-reference/beta/setup-intents/retrieve-setup-intent.md): Returns one setup intent. Related records are ids — once `status` is `succeeded`, `payment_method_id` is the saved method to charge or retrieve. The buyer's own token may retrieve a setup intent that belongs to it. - [Retrieve Setup Status](https://docs.whop.com/api-reference/beta/setup-intents/retrieve-setup-status.md): Retrieves how far a setup has got and what the buyer must do next, if anything. Collection runs in the background, so poll this rather than reading the create response. Accepts either a secret key or the setup's own `client_secret`, so the surface collecting the payment method can poll it directly. - [Create Setup Intent](https://docs.whop.com/api-reference/beta/setup-intents/create-setup-intent.md): Saves a buyer's payment method for later without charging it. Pass a `confirmation_token` for a method the buyer just supplied through the payment elements in setup mode, or a `payment_method_id` already on file to re-verify it. The response is the setup intent as created, not its outcome: it is `pr… - [Update Setup Return URL](https://docs.whop.com/api-reference/beta/setup-intents/update-setup-return-url.md): Changes where the buyer lands after completing an off-site step, up until they return. Accepts either a secret key or the setup's own `client_secret`, so the surface that knows the final destination can set it. - [Setupintent canceled](https://docs.whop.com/api-reference/beta/setup-intents/setupintent-canceled.md): Sent when a setup intent is canceled - [SetupIntent Requires Action](https://docs.whop.com/api-reference/beta/setup-intents/setupintent-requires-action.md): Sent when a setup intent is requires action - [Setupintent succeeded](https://docs.whop.com/api-reference/beta/setup-intents/setupintent-succeeded.md): Sent when a setup intent is succeeded #### Payment Rules - [Payment Rules](https://docs.whop.com/api-reference/beta/payment-rules/payment-rule.md) - [List Payment Rules](https://docs.whop.com/api-reference/beta/payment-rules/list-payment-rules.md) - [Retrieve a Payment Rule](https://docs.whop.com/api-reference/beta/payment-rules/retrieve-a-payment-rule.md) - [List Fields](https://docs.whop.com/api-reference/beta/payment-rules/list-fields.md): Small and returned in full on one page. - [Create a Payment Rule](https://docs.whop.com/api-reference/beta/payment-rules/create-a-payment-rule.md) - [Activate a Payment Rule](https://docs.whop.com/api-reference/beta/payment-rules/activate-a-payment-rule.md) - [Deactivate a Payment Rule](https://docs.whop.com/api-reference/beta/payment-rules/deactivate-a-payment-rule.md): The rule stops applying to new payments. It keeps its ID and can be activated again. - [Replace a Payment Rule](https://docs.whop.com/api-reference/beta/payment-rules/replace-a-payment-rule.md): Deletes this rule and creates its successor in one step. The successor carries a new ID and the metadata of the rule it replaced,. - [Update a Payment Rule](https://docs.whop.com/api-reference/beta/payment-rules/update-a-payment-rule.md): Changes the rule's name or metadata, keeping its ID and everything recorded against it. What the rule *does* is fixed once created, so the payments it decided keep naming the rule that decided them; use replace to change that. - [Delete a Payment Rule](https://docs.whop.com/api-reference/beta/payment-rules/delete-a-payment-rule.md): The rule stops applying to new payments and is kept, so the payments it already decided still name it. #### Disputes - [Disputes](https://docs.whop.com/api-reference/beta/disputes/dispute.md) - [List Disputes](https://docs.whop.com/api-reference/beta/disputes/list-disputes.md): Lists the disputes across the accounts you can read. - [Retrieve Dispute](https://docs.whop.com/api-reference/beta/disputes/retrieve-dispute.md): Retrieves a single dispute. - [Retrieve Dispute Summary](https://docs.whop.com/api-reference/beta/disputes/retrieve-dispute-summary.md): Totals up the same disputes the list returns, so you can build status tabs and totals without paging through them. - [Submit Dispute](https://docs.whop.com/api-reference/beta/disputes/submit-dispute.md): Sends a dispute's evidence to the payment processor. This is final — it cannot be edited or sent again. - [Upload Dispute Evidence](https://docs.whop.com/api-reference/beta/disputes/upload-dispute-evidence.md): Prefer `PATCH /disputes/{id}` with `evidence.documents` — it does the same replace alongside every other evidence field in one call. Replaces the full set of uploaded evidence documents on a dispute, beyond the four fixed evidence slots. Upload files through `POST /files` and reference them by `id`,… - [Update Dispute](https://docs.whop.com/api-reference/beta/disputes/update-dispute.md): Edits a dispute's evidence, while it is still editable. Sending it is a separate call. `evidence.documents`, when provided, replaces the full set of documents beyond the four fixed evidence slots — see its own description. - [Dispute created](https://docs.whop.com/api-reference/beta/disputes/dispute-created.md): Sent when a dispute is created - [Dispute updated](https://docs.whop.com/api-reference/beta/disputes/dispute-updated.md): Sent when a dispute is updated #### Dispute Alerts - [Dispute Alerts](https://docs.whop.com/api-reference/beta/dispute-alerts/dispute-alert.md) - [List Dispute Alerts](https://docs.whop.com/api-reference/beta/dispute-alerts/list-dispute-alerts.md): Lists the dispute alerts and early fraud warnings across the accounts you can read. - [Retrieve Dispute Alert](https://docs.whop.com/api-reference/beta/dispute-alerts/retrieve-dispute-alert.md): Retrieves a single dispute alert or early fraud warning by ID. - [Dispute alert created](https://docs.whop.com/api-reference/beta/dispute-alerts/dispute-alert-created.md): Sent when a dispute alert is created #### Resolution Center Cases - [List Resolution Center Cases](https://docs.whop.com/api-reference/beta/resolution-center-cases/list-resolution-center-cases.md): Lists resolution center cases. Without `account_id` you get every case you can read — the ones you opened as a buyer and every account you are a team member of; the filters narrow that list. - [Retrieve Resolution Center Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/retrieve-resolution-center-case.md): Retrieves a single resolution center case with its full event timeline. - [List Resolution Center Case Events](https://docs.whop.com/api-reference/beta/resolution-center-cases/list-resolution-center-case-events.md): Lists the case timeline, newest first. Events the viewer is not allowed to see are omitted — a customer reads the customer-visible timeline, the merchant reads the full one. - [Retrieve Resolution Center Case Summary](https://docs.whop.com/api-reference/beta/resolution-center-cases/retrieve-resolution-center-case-summary.md): Aggregates the same cases `GET /resolution_center_cases` lists, using the same filters. Use it to build status tabs and issue filters without paging the whole list. - [Open a Case as the Customer](https://docs.whop.com/api-reference/beta/resolution-center-cases/open-a-case-as-the-customer.md): Opens a case, as the customer, against one of your own payments. Provide the payment (`receipt_id`), the `reason`, and a `message`. - [Accept a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/accept-a-case.md): Accepts the case in the customer's favor, as the merchant: refunds the payment in full and closes the case. - [Appeal a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/appeal-a-case.md): Appeals a decision, as the customer, on a case that closed in the merchant's favor. Escalates the case to Whop for platform review. A case can be appealed once. - [Deny a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/deny-a-case.md): Denies the case, as the merchant: rejects the claim and closes the case with no refund. - [Reply to a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/reply-to-a-case.md): Replies to an open request for information on the case. As the merchant this answers Whop's request (valid while the case awaits your information); as the customer it provides the information requested from you. The actor is resolved from the credential. - [Request Information from the Customer](https://docs.whop.com/api-reference/beta/resolution-center-cases/request-information-from-the-customer.md): Asks the customer for more information, as the merchant. Allowed up to 3 times per case before you must accept or deny it. - [Withdraw a Case](https://docs.whop.com/api-reference/beta/resolution-center-cases/withdraw-a-case.md): Withdraws (cancels) a case you opened, as the customer. Only possible while the case is still open. - [Resolutioncentercase created](https://docs.whop.com/api-reference/beta/resolution-center-cases/resolutioncentercase-created.md): Sent when a resolution center case is created - [Resolutioncentercase decided](https://docs.whop.com/api-reference/beta/resolution-center-cases/resolutioncentercase-decided.md): Sent when a resolution center case is decided - [Resolutioncentercase updated](https://docs.whop.com/api-reference/beta/resolution-center-cases/resolutioncentercase-updated.md): Sent when a resolution center case is updated ### Money #### Financial Activity - [Ledger Activity](https://docs.whop.com/api-reference/beta/ledgers/ledger-activity.md) - [List Financial Activity](https://docs.whop.com/api-reference/beta/ledgers/list-financial-activity.md): Returns an account's or user's activity feed: every movement of money in or out. - [Get Financial Report](https://docs.whop.com/api-reference/beta/ledgers/get-financial-report.md): Returns a financial report — balance activity, income statement, or balance summary — for an account over a date range. - [Get Financial Report Breakdown](https://docs.whop.com/api-reference/beta/ledgers/get-financial-report-breakdown.md): Returns the top entities behind one high-level financial report bucket and an aggregate remainder. - [Financial Activity Funds Available](https://docs.whop.com/api-reference/beta/ledgers/financial-activity-funds-available.md): Sent when a settlement moves one release date's pending funds into the account's available balance — one event per release date that cleared, carrying that settlement's ledger line. Its posted_at is the release date at midnight UTC, the same value as settlement_time_at on every payment it clears #### Payouts - [Payouts](https://docs.whop.com/api-reference/beta/payouts/payout.md) - [List Payouts](https://docs.whop.com/api-reference/beta/payouts/list-payouts.md): Lists an account's or user's payouts, newest first. - [Retrieve Payout](https://docs.whop.com/api-reference/beta/payouts/retrieve-payout.md): Fetches one payout by its `wdrl_` ID, or by the `cofr_` conversion request ID a stablecoin payout carries as `payout_request_id` — both ids answer with the same payout object. Authentication is optional. Anyone with the ID can view payout tracking details, including notes, trace code, exchange rate,… - [List Saved Payout Methods](https://docs.whop.com/api-reference/beta/payouts/list-saved-payout-methods.md): Lists the bank accounts, wallets, and crypto addresses an account or user can pay out to, newest first. - [List Supported Payout Methods](https://docs.whop.com/api-reference/beta/payouts/list-supported-payout-methods.md): Lists the payout methods an account or user is eligible to add. - [Create Payout](https://docs.whop.com/api-reference/beta/payouts/create-payout.md): Sends money from an account or user balance to a saved payout method for that owner. - [Cancel Payout](https://docs.whop.com/api-reference/beta/payouts/cancel-payout.md): Cancels a payout that is still in review and returns the funds, fees included, to the balance. A payout can be canceled while its status is `in_review`. A `requested` payout is still being prepared (its funds may be converting) and answers 409 until it reaches review; from `processing` on, the money… - [Create Saved Payout Method](https://docs.whop.com/api-reference/beta/payouts/create-saved-payout-method.md): Saves a new place an account or user can pay out to. Sensitive details are vaulted in transit and never stored raw. - [Create Payout Quote](https://docs.whop.com/api-reference/beta/payouts/create-payout-quote.md): Creates a short-lived, provider-backed quote for a payout. No funds move until the returned quote_token is submitted to POST /payouts. An Idempotency-Key header is required. - [Update Saved Payout Method](https://docs.whop.com/api-reference/beta/payouts/update-saved-payout-method.md): Changes the label used to identify a saved payout method or makes it the account's default payout method. - [Delete Saved Payout Method](https://docs.whop.com/api-reference/beta/payouts/delete-saved-payout-method.md): Deletes a saved payout method so it can no longer receive payouts. - [Payoutmethod created](https://docs.whop.com/api-reference/beta/payouts/payoutmethod-created.md): Sent when a payout method is created - [Payout created](https://docs.whop.com/api-reference/beta/payouts/payout-created.md): Sent when a payout is created (this event family replaces withdrawal.*) - [Payout reversed](https://docs.whop.com/api-reference/beta/payouts/payout-reversed.md): Sent when a settled payout is reversed and the funds return to the balance (this event family replaces withdrawal.*) - [Payout updated](https://docs.whop.com/api-reference/beta/payouts/payout-updated.md): Sent when a payout's status changes (this event family replaces withdrawal.*) #### Cards - [Cards](https://docs.whop.com/api-reference/beta/cards/card.md) - [List Card Transactions](https://docs.whop.com/api-reference/beta/cards/list-card-transactions.md): Lists an account's card transactions, newest first. Defaults to the account the credential belongs to. Covers every card the owner has ever had, including canceled cards and spend that predates a re-application, and team members only see transactions on the cards assigned to them. Pass `transaction_… - [Retrieve Card Transaction](https://docs.whop.com/api-reference/beta/cards/retrieve-card-transaction.md): Fetches a single card transaction by its `citx_` identifier. The owner defaults to the account the credential belongs to. - [List Cards](https://docs.whop.com/api-reference/beta/cards/list-cards.md): Lists the Whop cards of an account or user, including ones still being set up. Team members only see the cards assigned to them. - [Retrieve Card](https://docs.whop.com/api-reference/beta/cards/retrieve-card.md): Retrieve a single card. - [Create Card](https://docs.whop.com/api-reference/beta/cards/create-card.md): Issue a virtual card, or apply for card issuing. An account with no application files one here and gets back a `202`; call again to issue the card once it is approved. - [Update Card](https://docs.whop.com/api-reference/beta/cards/update-card.md): Update, freeze, or cancel a card. Updating the card's name, billing address, or limits requires both `payout:account:update` and `company:balance:read`; a card's assigned holder may update their own card's pin and frozen state with any user token. - [Card application approved](https://docs.whop.com/api-reference/beta/cards/card-application-approved.md): Sent when a card application is approved - [Card application created](https://docs.whop.com/api-reference/beta/cards/card-application-created.md): Sent when a card application is created - [Card application denied](https://docs.whop.com/api-reference/beta/cards/card-application-denied.md): Sent when a card application is denied - [Card application updated](https://docs.whop.com/api-reference/beta/cards/card-application-updated.md): Sent when a card application is updated - [Cardtransaction completed](https://docs.whop.com/api-reference/beta/cards/cardtransaction-completed.md): Sent when a card transaction is completed - [Cardtransaction created](https://docs.whop.com/api-reference/beta/cards/cardtransaction-created.md): Sent when a card transaction is created - [Cardtransaction declined](https://docs.whop.com/api-reference/beta/cards/cardtransaction-declined.md): Sent when a card transaction is declined - [Cardtransaction reversed](https://docs.whop.com/api-reference/beta/cards/cardtransaction-reversed.md): Sent when a card transaction is reversed - [Cardtransaction updated](https://docs.whop.com/api-reference/beta/cards/cardtransaction-updated.md): Sent when a card transaction is updated - [Card canceled](https://docs.whop.com/api-reference/beta/cards/card-canceled.md): Sent when a card is canceled - [Card created](https://docs.whop.com/api-reference/beta/cards/card-created.md): Sent when a card is created - [Card frozen](https://docs.whop.com/api-reference/beta/cards/card-frozen.md): Sent when a card is frozen - [Card updated](https://docs.whop.com/api-reference/beta/cards/card-updated.md): Sent when a card is updated #### Cashback Rules - [Cashback Rule](https://docs.whop.com/api-reference/beta/cashback-rules/cashback-rule.md) - [List Cashback Rules](https://docs.whop.com/api-reference/beta/cashback-rules/list-cashback-rules.md): Lists all cashback rules funded by the authenticated platform account. Includes scheduled, expired, and discarded rules. Requires payout:transfer:read. Account-scoped credentials are required; there is no caller-supplied funding-account filter. - [Create Cashback Rule](https://docs.whop.com/api-reference/beta/cashback-rules/create-cashback-rule.md): Creates a future-dated card cashback rule funded by the authenticated platform account. Requires payout:transfer_funds. Merchant name and MCC are optional. Every supplied merchant filter must match. When both are omitted or null, scoped_account_id is required and all eligible transactions for that a… - [Pay Out Cashback](https://docs.whop.com/api-reference/beta/cashback-rules/pay-out-cashback.md): Distributes cashback on demand from the authenticated platform's available USD balance to its direct connected accounts. Requires payout:transfer_funds. Optional filters combine; an empty body includes all eligible transactions. Only completed, unpaid transactions created before this request are con… - [Update Cashback Rule](https://docs.whop.com/api-reference/beta/cashback-rules/update-cashback-rule.md): Updates a cashback rule funded by the authenticated platform account. Requires payout:transfer_funds. Only merchant_name, merchant_category_code, description, and expires_at can change; starts_at, rate_bps, funding_account_id, and scoped_account_id are immutable. Omitted fields stay unchanged. Sched… #### Transfers - [Transfers](https://docs.whop.com/api-reference/beta/transfers/transfer.md) - [List Transfers](https://docs.whop.com/api-reference/beta/transfers/list-transfers.md): Lists an account's transfers. - [Retrieve Transfer](https://docs.whop.com/api-reference/beta/transfers/retrieve-transfer.md): Retrieves a single transfer. - [List Transfer Recipients](https://docs.whop.com/api-reference/beta/transfers/list-transfer-recipients.md): Lists the people and accounts you can send money to. - [Create Transfer](https://docs.whop.com/api-reference/beta/transfers/create-transfer.md): Moves money between accounts, or into a claim link anyone with the URL can redeem. - [Transfer completed](https://docs.whop.com/api-reference/beta/transfers/transfer-completed.md): Sent to participating accounts when a transfer succeeds, including when a previously failed transfer succeeds after a retry. - [Transfer created](https://docs.whop.com/api-reference/beta/transfers/transfer-created.md): Sent to participating accounts when a transfer succeeds, alongside `transfer.completed`. This event does not indicate entry into `processing`. - [Transfer failed](https://docs.whop.com/api-reference/beta/transfers/transfer-failed.md): Sent to participating accounts when an existing transfer enters `failed`. The payload includes `failure_code`, `failure_reason`, and `failed_at`; a retry may later succeed under the same transfer ID. #### Deposits - [Deposits](https://docs.whop.com/api-reference/beta/deposits/deposit.md) - [Create Deposit](https://docs.whop.com/api-reference/beta/deposits/create-deposit.md): Retrieve the deposit methods for an account, including crypto and bank transfer. Crypto deposits require a $10 minimum. - [Deposit succeeded](https://docs.whop.com/api-reference/beta/deposits/deposit-succeeded.md): Sent when a deposit is succeeded #### Swaps - [Swaps](https://docs.whop.com/api-reference/beta/swaps/swap.md) - [List Swaps](https://docs.whop.com/api-reference/beta/swaps/list-swaps.md): Retrieve the account's completed or pending swaps — currently just the latest one. - [Retrieve Swap](https://docs.whop.com/api-reference/beta/swaps/retrieve-swap.md): Retrieves a single swap and its status. - [Create Swap](https://docs.whop.com/api-reference/beta/swaps/create-swap.md): Swaps one token for another from the account's wallet, or converts between fiat currencies in the account's ledger at the mid-market rate. Crypto swaps finish in the background — check the swap for its status. - [Create Swap Quote](https://docs.whop.com/api-reference/beta/swaps/create-swap-quote.md): Previews the price of a swap. Fiat pairs quote the in-ledger mid-market conversion — the same rate creating the swap fills at. No funds move and nothing is saved. - [Swap completed](https://docs.whop.com/api-reference/beta/swaps/swap-completed.md): Sent when a swap is completed #### Trades - [Trades](https://docs.whop.com/api-reference/beta/trades/trade.md) - [List Trades](https://docs.whop.com/api-reference/beta/trades/list-trades.md): Lists trades you can access, newest first. User credentials see their own trades and those of accounts they belong to, including connected accounts; account credentials see their account and its connected accounts. These are submission records, not fill or position history. - [Retrieve Trade](https://docs.whop.com/api-reference/beta/trades/retrieve-trade.md): Retrieves a trade. Order acknowledgements don't update as orders fill; read live orders and positions from the account's `trading` field. Never resubmit a `submission_unknown` trade with a new idempotency key. - [Create Trade](https://docs.whop.com/api-reference/beta/trades/create-trade.md): Submits perpetual orders from a funded trading wallet. Send several limit orders for a ladder, or attach `take_profit` and `stop_loss` to a single entry order. Whop's builder fee is approved and attached automatically. The returned `trop_` ID identifies the submission, not a position, and `completed… - [Cancel Trade](https://docs.whop.com/api-reference/beta/trades/cancel-trade.md): Cancels every order in an order trade, including attached take-profit and stop-loss. This doesn't close filled positions. Returns a new cancellation trade whose `trade_id` points to the original, which is left unchanged. Cancellation works even while opening new positions is disabled. Requires an `I… - [Update Trade Leverage](https://docs.whop.com/api-reference/beta/trades/update-trade-leverage.md): Sets cross or isolated leverage for a perpetual market, up to that market's maximum. Returns a trade recording the submission. Requires an `Idempotency-Key`. ### Commerce #### Products - [Product](https://docs.whop.com/api-reference/beta/products/product.md) - [List Products](https://docs.whop.com/api-reference/beta/products/list-products.md): Returns a paginated list of products. Omit `account_id` to search the public marketplace. - [Retrieve Product](https://docs.whop.com/api-reference/beta/products/retrieve-product.md): Retrieves a product. Public — no credentials. - [Create Product](https://docs.whop.com/api-reference/beta/products/create-product.md): Creates a new product for an account. - [Publish Product](https://docs.whop.com/api-reference/beta/products/publish-product.md): Submits a product to the whop.com marketplace for review. The product moves to `pending_review`; a Whop reviewer approves it before it goes live. Requires a logo, a headline, and at least one gallery image or video; the request fails naming whichever is missing. - [Unpublish Product](https://docs.whop.com/api-reference/beta/products/unpublish-product.md): Removes a product from the whop.com marketplace. The product moves to `not_available`. - [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. - [Product created](https://docs.whop.com/api-reference/beta/products/product-created.md): Sent when a product is created - [Product deleted](https://docs.whop.com/api-reference/beta/products/product-deleted.md): Sent when a product is deleted - [Product published](https://docs.whop.com/api-reference/beta/products/product-published.md): Sent when a product is published - [Product unpublished](https://docs.whop.com/api-reference/beta/products/product-unpublished.md): Sent when a product is unpublished - [Product updated](https://docs.whop.com/api-reference/beta/products/product-updated.md): Sent when a product is updated #### Waitlist Entries - [List Waitlist Entries](https://docs.whop.com/api-reference/beta/waitlist-entries/list-waitlist-entries.md): Lists visible waitlist signups. waitlist_entry:read grants the user's own signups; plan:waitlist:read grants signups for authorized seller accounts. With both permissions, returns their union. Account credentials are limited to their account. Filters narrow this set. - [Retrieve Waitlist Entry](https://docs.whop.com/api-reference/beta/waitlist-entries/retrieve-waitlist-entry.md): Retrieves a signup owned by the caller with waitlist_entry:read, or submitted to an account they can read with plan:waitlist:read. - [Create Waitlist Entry](https://docs.whop.com/api-reference/beta/waitlist-entries/create-waitlist-entry.md): Joins a free waitlist variant as the authenticated user. Requires waitlist_entry:create. Repeated joins return the existing pending entry, or an approved entry with a valid membership. Paid variants are rejected; no payment method is collected and no membership is granted. - [Approve Waitlist Entry](https://docs.whop.com/api-reference/beta/waitlist-entries/approve-waitlist-entry.md): Queues approval of a pending signup. Requires plan:waitlist:manage on its seller account. Paid signups may charge their saved payment method. Returns the signup's current state; retrieve it to read `status` and `approval_failure_reason` after processing. - [Cancel Waitlist Entry](https://docs.whop.com/api-reference/beta/waitlist-entries/cancel-waitlist-entry.md): Withdraws the caller's pending personal signup. Requires waitlist_entry:cancel. Does not cancel an approved membership. - [Deny Waitlist Entry](https://docs.whop.com/api-reference/beta/waitlist-entries/deny-waitlist-entry.md): Denies a pending signup. Requires plan:waitlist:manage on its seller account. - [Approve All Waitlist Entries](https://docs.whop.com/api-reference/beta/waitlist-entries/approve-all-waitlist-entries.md): Queues approval of every pending signup for an account, optionally narrowed to a variant. Requires plan:waitlist:manage. Paid signups may charge saved payment methods. Approval runs asynchronously: list signups with `status` set to `pending` to follow progress, and retrieve a signup to read its outc… #### Variants - [Variant](https://docs.whop.com/api-reference/beta/variants/variant.md) - [List Variants](https://docs.whop.com/api-reference/beta/variants/list-variants.md): Returns a paginated list of variants. Omit `account_id` and pass `product_ids` to list a product's public buyable variants. - [Retrieve Variant](https://docs.whop.com/api-reference/beta/variants/retrieve-variant.md): Retrieves the details of an existing variant. - [Create Variant](https://docs.whop.com/api-reference/beta/variants/create-variant.md): Create a new pricing variant for a product. The variant defines the billing interval, price, and availability for customers. - [Calculate Tax](https://docs.whop.com/api-reference/beta/variants/calculate-tax.md): Previews tax for a variant before checkout, based on the buyer's location. - [Update Variant](https://docs.whop.com/api-reference/beta/variants/update-variant.md): Update a variant's pricing, billing interval, visibility, stock, and other settings. - [Delete Variant](https://docs.whop.com/api-reference/beta/variants/delete-variant.md): Delete a variant from a product. It stops selling immediately; existing memberships on this variant will not be affected. - [Variant created](https://docs.whop.com/api-reference/beta/variants/variant-created.md): Sent when a variant is created - [Variant deleted](https://docs.whop.com/api-reference/beta/variants/variant-deleted.md): Sent when a variant is deleted - [Variant updated](https://docs.whop.com/api-reference/beta/variants/variant-updated.md): Sent when a variant is updated #### Plans - [Plan (Deprecated)](https://docs.whop.com/api-reference/beta/plans/plan.md) - [List Plans](https://docs.whop.com/api-reference/beta/plans/list-plans.md): Deprecated compatibility endpoint. List variants with `GET /variants` instead. - [Retrieve Plan](https://docs.whop.com/api-reference/beta/plans/retrieve-plan.md): Deprecated compatibility endpoint. Retrieve variants with `GET /variants/{id}` instead. - [Create Plan](https://docs.whop.com/api-reference/beta/plans/create-plan.md): Deprecated compatibility endpoint. Create variants with `POST /variants` instead. - [Calculate Tax](https://docs.whop.com/api-reference/beta/plans/calculate-tax.md): Deprecated compatibility endpoint. Preview variant tax with `POST /variants/{id}/calculate_tax` instead. - [Update Plan](https://docs.whop.com/api-reference/beta/plans/update-plan.md): Deprecated compatibility endpoint. Update variants with `PATCH /variants/{id}` instead. - [Delete Plan](https://docs.whop.com/api-reference/beta/plans/delete-plan.md): Deprecated compatibility endpoint. Delete variants with `DELETE /variants/{id}` instead. #### Promo Codes - [List Promo Codes](https://docs.whop.com/api-reference/beta/promo-codes/list-promo-codes.md): Lists promo codes for an account with cursor pagination, filters, and sorting. - [Retrieve Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/retrieve-promo-code.md): Retrieves a promo code by ID. - [Create Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/create-promo-code.md): Creates a promo code for an account. First-party sessions may attach an affiliate. - [Activate Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/activate-promo-code.md): Turns an inactive promo code back on so it can be redeemed at checkout. - [Deactivate Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/deactivate-promo-code.md): Turns off an active promo code so it can no longer be redeemed at checkout. - [Delete Promo Code](https://docs.whop.com/api-reference/beta/promo-codes/delete-promo-code.md): Archives a promo code so it cannot be used in future checkouts. #### Memberships - [Membership](https://docs.whop.com/api-reference/beta/memberships/membership.md) - [List Memberships](https://docs.whop.com/api-reference/beta/memberships/list-memberships.md): Lists every membership the caller can read: an account API key its account's; a user credential their own plus those of every account they manage. `account_id` and `user_id` only narrow that list — values outside the caller's reach return fewer results, not an error. - [Retrieve Membership](https://docs.whop.com/api-reference/beta/memberships/retrieve-membership.md): Retrieves a membership by ID or license key. Accessible to the account and to the membership's own user. - [Apply Promo Code to Membership](https://docs.whop.com/api-reference/beta/memberships/apply-promo-code-to-membership.md): Applies a promo code to an `active` or `trialing` membership that does not already have one and has exactly one recurring item. The discount lands on the next invoice and follows the code's duration (`once`, `repeating`, or `forever`). Works for Stripe-billed memberships and memberships billed by Wh… - [Assign Affiliate to Membership](https://docs.whop.com/api-reference/beta/memberships/assign-affiliate-to-membership.md): Assigns an affiliate to a membership and pays them the commission you set on its future payments. Name the user with exactly one of `user_id`, `email`, or `username`. A user who is not yet an affiliate of your account becomes one, which also requires `affiliate:create`. Send a new `commission_type`… - [Cancel Membership](https://docs.whop.com/api-reference/beta/memberships/cancel-membership.md): Cancels a membership. Pass `cancel_at_period_end: true` to stop auto-renewal and keep access until the current billing period ends. Omit it (or pass `false`) to revoke access immediately. Buyers cannot cancel buy-now-pay-later (`splitit`, `sezzle`) or non-trial split-pay memberships. - [Extend Membership](https://docs.whop.com/api-reference/beta/memberships/extend-membership.md): Adds free days to a membership, extending its current billing period, expiration date, or trial depending on the plan type. - [Pause Membership](https://docs.whop.com/api-reference/beta/memberships/pause-membership.md): Pauses a membership's recurring payment collection. The customer keeps access but is not charged until the membership is resumed. - [Reactivate Membership](https://docs.whop.com/api-reference/beta/memberships/reactivate-membership.md): Restores access to a `canceled` or `expired` membership that contains only one-time purchases and sets its `status` to `completed`. Lifetime memberships regain lifetime access. For memberships with an expiration, `days` sets `current_period_end` that many days from now; without it the original `curr… - [Resume Membership](https://docs.whop.com/api-reference/beta/memberships/resume-membership.md): Resumes a previously paused membership's recurring payment collection. Billing resumes on the next cycle. - [Resync Membership Access](https://docs.whop.com/api-reference/beta/memberships/resync-membership-access.md): Re-runs access fulfillment for a membership: recomputes the member's content access on Whop, re-validates their Discord link (re-adding them to the server and re-assigning roles if needed), and re-fulfills TradingView indicator access. Telegram access is invite-based and is not resynced. The work ru… - [Transfer Membership](https://docs.whop.com/api-reference/beta/memberships/transfer-membership.md): Creates a one-use transfer URL for a membership. Opening the URL while logged into a different Whop account claims the membership onto that account. The membership's buyer can generate a link for their own membership with `membership:transfer` when the product allows transfers and the membership is… - [Invite to a Membership](https://docs.whop.com/api-reference/beta/memberships/invite-to-a-membership.md): Sends an email inviting one recipient to join the account through a free variant. Identify the recipient by exactly one of `user_id` or `email`. The invitation is bound to that recipient; after signing in, accepting it immediately grants the membership without checkout. This Experimental endpoint is… - [Update Membership](https://docs.whop.com/api-reference/beta/memberships/update-membership.md): Updates a membership: merge metadata key-value pairs, toggle `cancel_at_period_end` — `true` schedules the cancellation for the end of the current billing period, `false` reverses a pending one — or move future renewals to another of the customer's saved payment methods with `payment_method_id`, or… - [Membership activated](https://docs.whop.com/api-reference/beta/memberships/membership-activated.md): Sent when a membership is activated - [Membership Trial Ending Soon](https://docs.whop.com/api-reference/beta/memberships/membership-trial-ending-soon.md): Sent when a membership is trial ending soon - [Membership updated](https://docs.whop.com/api-reference/beta/memberships/membership-updated.md): Sent whenever a membership changes: it activates or deactivates, cancel_at_period_end flips, or the seller edits its billing period, price or renewal date. previous_attributes carries the values that changed from. membership.activated is also delivered as a membership.updated, so you can subscribe t… #### Checkout Configurations - [Checkout Configuration](https://docs.whop.com/api-reference/beta/checkout-configurations/checkout-configuration.md) - [List Checkout Configurations](https://docs.whop.com/api-reference/beta/checkout-configurations/list-checkout-configurations.md): Lists checkout configurations for an account. - [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. - [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 variant. - [Delete a Checkout Configuration](https://docs.whop.com/api-reference/beta/checkout-configurations/delete-a-checkout-configuration.md): Deletes a checkout configuration so its checkout URL can no longer be used. #### Payment Method Domains - [Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/payment-method-domain.md) - [List Payment Method Domains](https://docs.whop.com/api-reference/beta/payment-method-domains/list-payment-method-domains.md): Lists payment method domains. Without `account_id`, returns the caller's own domains and those of every connected account. - [Retrieve Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/retrieve-payment-method-domain.md): Retrieves a payment method domain to check its verification status. - [Create Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/create-payment-method-domain.md): Registers a hostname with the wallet provider and attempts verification inline. Returns `verified` when the provider fetched the domain-association file (for Apple Pay, `/.well-known/apple-developer-merchantid-domain-association`), or `pending` when it could not — host the file, then retry with the… - [Verify Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/verify-payment-method-domain.md): Re-attempts provider verification of a pending domain once the association file is hosted. Fails with a `bad_request` explaining what to fix; verifying an already `verified` domain is a no-op. - [Delete Payment Method Domain](https://docs.whop.com/api-reference/beta/payment-method-domains/delete-payment-method-domain.md): Unregisters a payment method domain so its wallet payment methods stop rendering there. #### Shipments - [List Shipments](https://docs.whop.com/api-reference/beta/shipments/list-shipments.md): Returns a paginated list of shipments for an account. - [Retrieve Shipment](https://docs.whop.com/api-reference/beta/shipments/retrieve-shipment.md): Retrieves a shipment by its id, or by the payment id it fulfills. - [Create Shipment](https://docs.whop.com/api-reference/beta/shipments/create-shipment.md): Attaches a carrier tracking number to a payment and begins tracking it. - [Update Shipment](https://docs.whop.com/api-reference/beta/shipments/update-shipment.md): Updates a shipment's tracking number and re-tracks it with the carrier. - [Shipment created](https://docs.whop.com/api-reference/beta/shipments/shipment-created.md): Sent when a shipment is created - [Shipment updated](https://docs.whop.com/api-reference/beta/shipments/shipment-updated.md): Sent when a shipment is updated ### Affiliate Program #### Product Affiliates - [List Product Affiliates](https://docs.whop.com/api-reference/beta/product-affiliates/list-product-affiliates.md): Lists affiliate enrollments for an account's products, newest first, including affiliates who have not made a referral. Requires `affiliate:basic:read` on the account. Email addresses and email search also require `member:email:read`. ### Partners #### Partner Referral Requests - [List Partner Referral Requests](https://docs.whop.com/api-reference/beta/partner-referral-requests/list-partner-referral-requests.md): Lists your referral links and attribution requests, including incoming requests for you or businesses you own, with filters for recipient, partner, type, and status. - [Retrieve a Partner Referral Request](https://docs.whop.com/api-reference/beta/partner-referral-requests/retrieve-a-partner-referral-request.md): Retrieves a referral link or attribution request by ID, including its partner, recipient, approval status, and referral code when present. - [Create a Partner Referral Request](https://docs.whop.com/api-reference/beta/partner-referral-requests/create-a-partner-referral-request.md): Creates a referral link or sends a verified partner's attribution request to an existing business or user for approval. Recipients do not need to join the partner program. - [Accept a Partner Referral Request](https://docs.whop.com/api-reference/beta/partner-referral-requests/accept-a-partner-referral-request.md): Accepts a pending attribution request as the receiving user or business owner, assigning the requesting partner as that user's or business's referrer. - [Cancel a Partner Referral Request](https://docs.whop.com/api-reference/beta/partner-referral-requests/cancel-a-partner-referral-request.md): Cancels a pending attribution request you sent so the recipient can no longer accept it, and returns the cancelled request. - [Decline a Partner Referral Request](https://docs.whop.com/api-reference/beta/partner-referral-requests/decline-a-partner-referral-request.md): Declines a pending attribution request for you or a business you own, marking it as denied without assigning the requesting partner as a referrer. #### Partners - [Partners](https://docs.whop.com/api-reference/beta/partners/partner.md) - [Retrieve a Partner](https://docs.whop.com/api-reference/beta/partners/retrieve-a-partner.md): Retrieves the authenticated user's public profile, enrollment date, partner verification timestamp, verification waitlist status, partner certification completion, active direct business referral count, and default payout rates. Use me or the authenticated user's own user ID; other users are not acc… - [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 by default, each with the caller's total affiliate earnings from that user across all tiers. Earnings sorting uses cached totals. Authorized staff can set user_id=global to list referrals across partners, with earnings for each user's curre… - [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. ### Workforce #### Bounties - [Bounty](https://docs.whop.com/api-reference/beta/bounties/bounty.md) - [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. - [Retrieve Bounty](https://docs.whop.com/api-reference/beta/bounties/retrieve-bounty.md): Retrieves a bounty by ID. Authentication is optional: a request with no credential reads the bounty when it is publicly visible — published or completed, and not restricted to a private experience's members. Bounties outside the caller's scope, and bounties not publicly visible to an anonymous calle… - [List Public Submissions](https://docs.whop.com/api-reference/beta/bounties/list-public-submissions.md): Lists a bounty's publicly visible work — submitted, approved, and denied submissions in the reduced public shape. Authentication is optional; a bounty that is not publicly visible returns `404`. - [Retrieve Public Submission](https://docs.whop.com/api-reference/beta/bounties/retrieve-public-submission.md): Retrieves one of a bounty's publicly visible submissions in the reduced public shape — the read behind a shared proof link, whose submission is usually outside the bounty page's capped preview. Authentication is optional; a bounty that is not publicly visible, and a submission that is not publicly v… - [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`. - [Cancel](https://docs.whop.com/api-reference/beta/bounties/cancel.md): Cancels a bounty. With no in-flight work, it cancels immediately and refunds the funder. Otherwise it stops new submissions and cancels once the in-flight work resolves and pays out. Repeating the request is a no-op. A bounty that already paid out every slot returns `400`. - [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. #### Bounty Submissions - [List Bounty Submissions](https://docs.whop.com/api-reference/beta/bounty-submissions/list-bounty-submissions.md): Lists bounty submissions visible to the credential — for a user token, the submissions they authored plus those on bounties they posted; for an account API key, the submissions on the account's bounties. For the anonymous view of one bounty's reviewed work, use the submissions list under the bounty… - [Retrieve Bounty Submission](https://docs.whop.com/api-reference/beta/bounty-submissions/retrieve-bounty-submission.md): Retrieves one bounty submission the credential can see — one the caller authored, or one on a bounty they posted or their account owns. Reading another member's work on an account's bounty takes `account_id`, the same way the list does. - [Create Bounty Submission](https://docs.whop.com/api-reference/beta/bounty-submissions/create-bounty-submission.md): Creates a submission on a workforce bounty. Include a `deliverable` payload — any combination of links and uploaded files, with at least one of the two — and the submission goes straight to review; create is the only step. For `data_capture` bounties, omit the deliverable: this starts a claimed atte… - [Submit Bounty Submission](https://docs.whop.com/api-reference/beta/bounty-submissions/submit-bounty-submission.md): Submits a claimed attempt for review. A livestream attempt needs an ended proof stream and can attach an optional `deliverable` — links, files, and a caption in any combination; if the attempt already went to review when its stream ended, the payload attaches to it once, until reviewers start voting… - [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. ### Tracking #### People - [People](https://docs.whop.com/api-reference/beta/people/person.md) - [List People](https://docs.whop.com/api-reference/beta/people/list-people.md): Lists the people (visitors and customers) of an account: the identity-linked person profiles aggregated from every pixel, payment, and platform event — identities, purchases and LTV, geo/device profile, traffic sources, and first/last marketing touches. - [Retrieve Person](https://docs.whop.com/api-reference/beta/people/retrieve-person.md): Retrieves one person for an account. The identifier can be a person ID (prefixed `prsn_`), a user ID (prefixed `user_`), an email address, or a phone number — merged people resolve to the surviving profile. #### Events - [Events](https://docs.whop.com/api-reference/beta/events/event.md) - [List Events](https://docs.whop.com/api-reference/beta/events/list-events.md): Lists identity-linked events, most recent first by default. Pass identifier for one person's journey, or omit it to list events for an account within an explicit time range. Pass direction=asc to read a journey forwards from where it starts. Events are shaped like the POST /events intake: attributio… - [Retrieve the Pulse Feed](https://docs.whop.com/api-reference/beta/events/retrieve-the-pulse-feed.md): Returns a fully anonymized feed of recent platform-wide money movement, most recent first: purchases, affiliate commissions, card and ad spend, app revenue, off-platform sales, wallet deposits, card loads, claimed drops, transfers between accounts, and referral bonuses. Items carry only a `type`, th… - [Create Event](https://docs.whop.com/api-reference/beta/events/create-event.md): Tracks a conversion or engagement event for an account. - [Validate Pixel](https://docs.whop.com/api-reference/beta/events/validate-pixel.md): Checks whether the Whop pixel is installed for an account. Recent pixel events count as proof on their own, so an account that has sent data lately comes back installed without a `url`. Pass a `url` and events from that page settle it; conversion events are also read across the hostname because they… ### Ads - [Overview](https://docs.whop.com/api-reference/beta/ads/overview.md) #### Ads - [Ad](https://docs.whop.com/api-reference/beta/ads/ad.md) - [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. - [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. - [Create an Ad](https://docs.whop.com/api-reference/beta/ads/create-an-ad.md): Creates an ad in an ad group. Any campaign status other than `draft` launches the campaign, which requires an ads payment method on the account. - [Duplicate an Ad](https://docs.whop.com/api-reference/beta/ads/duplicate-an-ad.md): Copies the ad into its own ad group, or into target_ad_group_id (which must belong to the same account and be compatible with the ad). Copies keep the source ad's active/paused state. - [Pause an Ad](https://docs.whop.com/api-reference/beta/ads/pause-an-ad.md): Pauses an active ad. - [Unpause an Ad](https://docs.whop.com/api-reference/beta/ads/unpause-an-ad.md): Resumes a paused ad. - [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. - [Ad updated](https://docs.whop.com/api-reference/beta/ads/ad-updated.md): Sent when an ad's status or delivery_status changes, including the in_review and rejected verdicts from ad review. previous_attributes carries the values they changed from; the payload carries no performance stats #### Ad Conversion Value Rules - [Conversion Value Rule](https://docs.whop.com/api-reference/beta/ad-conversion-value-rules/ad-conversion-value-rule.md) - [List Conversion Value Rules](https://docs.whop.com/api-reference/beta/ad-conversion-value-rules/list-conversion-value-rules.md): List saved rules the caller can read. Filter by business with account_id. - [Retrieve a Conversion Value Rule](https://docs.whop.com/api-reference/beta/ad-conversion-value-rules/retrieve-a-conversion-value-rule.md) - [Create a Conversion Value Rule](https://docs.whop.com/api-reference/beta/ad-conversion-value-rules/create-a-conversion-value-rule.md): Create one rule covering every selected target and event combination. Active rules cannot overlap for the same platform and event. Customer prices and Whop revenue stay unchanged. - [Pause a Conversion Value Rule](https://docs.whop.com/api-reference/beta/ad-conversion-value-rules/pause-a-conversion-value-rule.md): Pause the rule across all selected targets and events. - [Unpause a Conversion Value Rule](https://docs.whop.com/api-reference/beta/ad-conversion-value-rules/unpause-a-conversion-value-rule.md): Resume the rule and automatically replace overlapping selections in the same transaction. Other selections keep their values, and broader rules remain as defaults. Rules with no remaining selections are paused. Resuming an already-active rule makes no changes. - [Update a Conversion Value Rule](https://docs.whop.com/api-reference/beta/ad-conversion-value-rules/update-a-conversion-value-rule.md): Edit a rule without changing its status. Supplied targets or events replace that selection in full. Omitted fields stay unchanged. All changes succeed or fail together. - [Delete a Conversion Value Rule](https://docs.whop.com/api-reference/beta/ad-conversion-value-rules/delete-a-conversion-value-rule.md): Soft-delete a rule and deactivate all its coverage. Preserve its stored settings. #### Ad Campaigns - [Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign.md) - [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. - [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. - [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. - [Duplicate an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/duplicate-an-ad-campaign.md): Creates copies of the campaign in `duplicating` status and returns them; each copy transitions to `draft` once duplication completes. Poll each returned campaign until it leaves `duplicating` — a copy that could not be completed is deleted and returns 404. - [Pause an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/pause-an-ad-campaign.md): Pauses an active ad campaign. - [Retry a Failed Ad Campaign Payment](https://docs.whop.com/api-reference/beta/ad-campaigns/retry-a-failed-ad-campaign-payment.md): Queues a background payment retry for the campaign's entire account, including other campaigns with failed payments. Deprecated: API versions 2026-09-22 and later return 410 Gone. Use POST /accounts/{id}/retry_ads_payment instead. The returned campaign does not confirm payment success; read delivery… - [Unpause an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/unpause-an-ad-campaign.md): Resumes a paused ad campaign. Requires an ads payment method on the account. - [Update an Ad Campaign](https://docs.whop.com/api-reference/beta/ad-campaigns/update-an-ad-campaign.md): Updates an ad campaign's editable fields (title, budget, schedule, bid strategy, special ad categories, and, before launch, budget type and budget optimization), and launches a draft campaign by setting status to active. Objective and desired cost per result are fixed at creation and cannot be chang… - [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). - [Ad Campaign Payment Failed](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign-payment-failed.md): Sent when an ad campaign's payment fails and its ads stop delivering. The payload carries no performance stats; read the campaign for those - [Ad campaign updated](https://docs.whop.com/api-reference/beta/ad-campaigns/ad-campaign-updated.md): Sent when an ad campaign's status or delivery_status changes. previous_attributes carries the values they changed from; the payload carries no performance stats #### Ad Groups - [Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/ad-group.md) - [List Ad Groups](https://docs.whop.com/api-reference/beta/ad-groups/list-ad-groups.md): Lists ad groups for the account, newest first. - [Retrieve an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/retrieve-an-ad-group.md): Retrieves a single ad group. - [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 `query` browses the small fixed lists (behavio… - [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. - [Duplicate an Ad Group](https://docs.whop.com/api-reference/beta/ad-groups/duplicate-an-ad-group.md): Creates copies of the ad group in `duplicating` status and returns them — into its own campaign, or into target_ad_campaign_id (which must belong to the same account and be compatible with the ad group's targeting and goals); each copy transitions to its final status (matching the source's active/pa… - [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 nothing is persisted. - [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. #### Audiences - [Audience](https://docs.whop.com/api-reference/beta/audiences/audience.md) - [Create](https://docs.whop.com/api-reference/beta/audiences/create-audience.md): Create an audience from a customer list, your account's Whop People data, or engagement with videos, lead forms, Instagram profiles, or Facebook pages. Create lookalike audiences to reach people similar to an existing audience. Processing runs asynchronously. Custom creation returns one audience; lo… - [List Audiences](https://docs.whop.com/api-reference/beta/audiences/list-audiences.md): List custom and lookalike audiences for an account. Pass `audience_id` to return a specific audience. - [Add People](https://docs.whop.com/api-reference/beta/audiences/add-people.md): Adds users from a new CSV file to an existing uploaded custom audience. The file uses the audience's saved column mapping, processing happens in the background, and existing audience members remain unchanged. - [Update Audience](https://docs.whop.com/api-reference/beta/audiences/update-audience.md): Renames an audience. For an audience built from People filters that keeps itself up to date, pass `filters` to replace them, which rebuilds membership immediately. Whether an audience auto refreshes is set when it is created. - [Delete Audience](https://docs.whop.com/api-reference/beta/audiences/delete-audience.md): Deletes an audience so it is no longer available for targeting. ### Media #### Files - [List Files](https://docs.whop.com/api-reference/beta/files/list-files.md): Returns the files with the given IDs, newest first — fetch a batch in one request instead of retrieving each file individually. Only files you created are returned; IDs that do not exist, or that another credential created, are omitted. A request for up to 100 IDs answers in a single page by default… - [Retrieve File](https://docs.whop.com/api-reference/beta/files/retrieve-file.md): Retrieves a file you uploaded — poll it after uploading the bytes to see `upload_status` become `ready`. Only the creator can retrieve a file this way; a file attached to another resource is read through that resource. - [Create File](https://docs.whop.com/api-reference/beta/files/create-file.md): Creates a file and returns a presigned destination to upload its bytes to. PUT the bytes to `upload_url` (single-part), or to each of `multipart_upload_urls` and then call Complete File Multipart Upload. Once the bytes land the file becomes `ready`, and its ID can be attached wherever a file is acce… - [Complete File Multipart Upload](https://docs.whop.com/api-reference/beta/files/complete-file-multipart-upload.md): Assembles the parts of a multipart upload after every part has been PUT to its presigned URL. Pass the `multipart_upload_id` from Create File and each part's `ETag` response header. For a step-by-step walkthrough of multipart uploads, see the [direct file uploads guide](/developer/guides/direct-file… #### Media - [Media](https://docs.whop.com/api-reference/beta/media/media.md) - [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. ### Identity #### External Accounts - [External Account](https://docs.whop.com/api-reference/beta/external-accounts/external-account.md) - [List External Accounts](https://docs.whop.com/api-reference/beta/external-accounts/list-external-accounts.md): Lists the external accounts linked to an account or user. - [List External Account Lead Forms](https://docs.whop.com/api-reference/beta/external-accounts/list-external-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 External Account Partners](https://docs.whop.com/api-reference/beta/external-accounts/list-external-account-partners.md): Lists the creators an Instagram account runs partnership ads with, and where each creator's permission stands. - [List External Account Posts](https://docs.whop.com/api-reference/beta/external-accounts/list-external-account-posts.md): Lists the existing posts of a connected Facebook page, Instagram account, or TikTok account. - [Create an External Account](https://docs.whop.com/api-reference/beta/external-accounts/create-an-external-account.md): Creates or returns a Whop-managed Facebook page or TikTok account for an account. - [Add Partner](https://docs.whop.com/api-reference/beta/external-accounts/add-partner.md): Invites an Instagram creator to run partnership ads with an Instagram account. The creator approves the invitation in the Instagram app, and `partnership_status` stays `pending` until they do; [refresh](/api-reference/beta/external-accounts/refresh) the partner to pick up their answer. - [Refresh](https://docs.whop.com/api-reference/beta/external-accounts/refresh.md): Refreshes the state of an external account. Use it to clear an `error` that has been resolved. - [Connect an External Account](https://docs.whop.com/api-reference/beta/external-accounts/connect-an-external-account.md): Starts an OAuth connection flow and returns an authorize_url where the user can connect an external account. LinkedIn supports personal profiles only, with scopes omitted. TikTok connects the authenticated user’s profile when scopes are omitted or company advertising assets with advertise. Meta Busi… - [Delete an External Account](https://docs.whop.com/api-reference/beta/external-accounts/delete-an-external-account.md): Disconnects an external account from an account or user without deleting the underlying platform account. - [Remove Partner](https://docs.whop.com/api-reference/beta/external-accounts/remove-partner.md): Revokes a creator's permission to run partnership ads with an Instagram account. Every account that advertises as the Instagram account loses the partner, since the permission belongs to the Instagram account. #### Social Accounts - [Social Account (Deprecated)](https://docs.whop.com/api-reference/beta/social-accounts/social-account.md) - [List Social Accounts](https://docs.whop.com/api-reference/beta/social-accounts/list-social-accounts.md): Deprecated compatibility endpoint. List external accounts with `GET /external_accounts` instead. - [List Social Account Lead Forms](https://docs.whop.com/api-reference/beta/social-accounts/list-social-account-lead-forms.md): Deprecated compatibility endpoint. List lead forms with `GET /external_accounts/{id}/lead_forms` instead. - [List Social Account Partners](https://docs.whop.com/api-reference/beta/social-accounts/list-social-account-partners.md): Deprecated compatibility endpoint. List partners with `GET /external_accounts/{external_account_id}/partners` instead. - [List Social Account Posts](https://docs.whop.com/api-reference/beta/social-accounts/list-social-account-posts.md): Deprecated compatibility endpoint. List posts with `GET /external_accounts/{id}/posts` instead. - [Create a Social Account](https://docs.whop.com/api-reference/beta/social-accounts/create-a-social-account.md): Deprecated compatibility endpoint. Create external accounts with `POST /external_accounts` instead. - [Add Partner](https://docs.whop.com/api-reference/beta/social-accounts/add-partner.md): Deprecated compatibility endpoint. Add partners with `POST /external_accounts/{external_account_id}/partners` instead. - [Refresh](https://docs.whop.com/api-reference/beta/social-accounts/refresh.md): Deprecated compatibility endpoint. Refresh external accounts with `POST /external_accounts/{id}/refresh` instead. - [Connect a Social Account](https://docs.whop.com/api-reference/beta/social-accounts/connect-a-social-account.md): Deprecated compatibility endpoint. Connect external accounts with `POST /external_accounts/connect` instead. - [Delete a Social Account](https://docs.whop.com/api-reference/beta/social-accounts/delete-a-social-account.md): Deprecated compatibility endpoint. Disconnect external accounts with `DELETE /external_accounts/{id}` instead. - [Remove Partner](https://docs.whop.com/api-reference/beta/social-accounts/remove-partner.md): Deprecated compatibility endpoint. Remove partners with `DELETE /external_accounts/{external_account_id}/partners/{id}` instead. ### Developer #### Apps - [App](https://docs.whop.com/api-reference/beta/apps/app.md) - [List Apps](https://docs.whop.com/api-reference/beta/apps/list-apps.md): Lists apps on the Whop platform: the app store's live apps, or — with `account_id` and developer access to that account — every app the account owns. Requires authentication except for Whop's public app and website discovery lists. Public website discovery includes built official blueprints (verifie… - [Retrieve App](https://docs.whop.com/api-reference/beta/apps/retrieve-app.md): Retrieves an app by ID, claimed route, active verified custom hostname, or proxy domain id. Custom hostnames return 404 for inactive assignments, suspended accounts, or deleted apps. Credential fields (api_key, default_api_key, secrets) render `null` unless the caller has the corresponding developer… - [List App Logs](https://docs.whop.com/api-reference/beta/apps/list-app-logs.md): Lists a hosted app's server runtime logs, most recent first: console output, uncaught exceptions, and failed-request summaries captured on whop.site hosting. Logs are retained for 7 days. - [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. - [Deploy App](https://docs.whop.com/api-reference/beta/apps/deploy-app.md): Builds the app's current source and ships it. Returns the run it started, so the caller can render progress from this response and then follow it on the app's `deployment` field. Only one deployment runs per app at a time — calling this while one is in flight reports that run rather than starting a… - [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. - [Update App Permissions](https://docs.whop.com/api-reference/beta/apps/update-app-permissions.md): Replaces the set of permissions the app requests from users when they install it. Requires a user session: the `developer:update_app_authorization` scope cannot be delegated to API keys. Sensitive permissions require step-up verification. - [Delete App](https://docs.whop.com/api-reference/beta/apps/delete-app.md): Deletes an app. The app stops resolving within seconds — a website's site stops serving, and any claimed subdomain is reserved for a month before it can be claimed again. #### Domains - [Domain](https://docs.whop.com/api-reference/beta/domains/domain.md) - [List Domains](https://docs.whop.com/api-reference/beta/domains/list-domains.md): Lists your domains. Filter by account, app, status, or hostname. - [Retrieve Domain](https://docs.whop.com/api-reference/beta/domains/retrieve-domain.md): Retrieves a domain's status, issues, billing, and DNS records, and checks it again in the background if it isn't active yet. - [Create Domain](https://docs.whop.com/api-reference/beta/domains/create-domain.md): Buys a domain through Whop, or connects one you registered elsewhere. - [Update Domain](https://docs.whop.com/api-reference/beta/domains/update-domain.md): Reassigns a domain to another app in the same account, replaces its metadata, or changes how a bought domain renews. The hostname and owning account cannot be edited. - [Delete Domain](https://docs.whop.com/api-reference/beta/domains/delete-domain.md): Stops routing a connected domain to its app and starts cleanup: it returns as `deleting`; retrieve it until it's `removed`. Deleting an unpaid purchase cancels it. A registered domain can't be deleted; turn off `auto_renew` and it's released after it expires. #### App Builds - [App Build](https://docs.whop.com/api-reference/beta/app-builds/app-build.md) - [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. - [Retrieve App Build](https://docs.whop.com/api-reference/beta/app-builds/retrieve-app-build.md): Retrieves the details of an existing app build. - [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. - [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 Keys - [API Key](https://docs.whop.com/api-reference/beta/api-keys/api-key.md) - [List API Keys](https://docs.whop.com/api-reference/beta/api-keys/list-api-keys.md): Lists the API keys of an account or app, newest first. Responses never include the full secret — only its obfuscated form. - [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. - [List the Permission Catalog](https://docs.whop.com/api-reference/beta/api-keys/list-the-permission-catalog.md): Lists the catalog of permission actions that can be granted to users, apps, and API keys — the source for the dashboard's permission pickers. Small and returned in full on one page. - [Create API Key](https://docs.whop.com/api-reference/beta/api-keys/create-api-key.md): Creates an API key for an account or app. The response is the only place the full `secret_key` is returned — store it immediately. Requires a user session; API keys cannot manage API keys. - [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. - [Update API Key](https://docs.whop.com/api-reference/beta/api-keys/update-api-key.md): Updates an API key's name, permissions, API version, expiration, or IP allowlist. Fields that are omitted keep their current value; default keys cannot be modified. - [Delete API Key](https://docs.whop.com/api-reference/beta/api-keys/delete-api-key.md): Permanently revokes an API key; requests using its secret stop authenticating immediately. Default and agent-backend keys cannot be deleted. #### API Logs - [List API Logs](https://docs.whop.com/api-reference/beta/api-logs/list-api-logs.md): Lists the requests served by Whop's API with the account's API keys, newest first — every surface (GraphQL, REST, and native /api/v1), reads and failed requests included. #### Permissions - [Permission](https://docs.whop.com/api-reference/beta/permissions/permission.md) - [Check Permissions](https://docs.whop.com/api-reference/beta/permissions/check-permissions.md): Lists permission actions and whether the calling credential is granted each one for a resource. Answers for whichever identity authenticated the request — a user session, an OAuth token, or an account or app API key — so it never describes who else can reach the resource. #### Experiments - [List Experiments](https://docs.whop.com/api-reference/beta/experiments/list-experiments.md): Lists experiments for one account with experiment:read permission. Omit account_id or pass internal to list internal experiments, which requires Whop internal access. - [Retrieve Experiment](https://docs.whop.com/api-reference/beta/experiments/retrieve-experiment.md): Retrieves a single experiment or feature flag by its `expt_` id or flag_key handle. Requires the corresponding experiment permission on the owning account, or Whop internal access for internal experiments. - [Evaluate Experiments](https://docs.whop.com/api-reference/beta/experiments/evaluate-experiments.md): Evaluates and records an exposure without requiring authentication. When credentials resolve, their authentication method, API key ID, and signed-in user ID are recorded on the exposure event. Pass subject for bucketing identity and account_id for experiment ownership. - [Create Experiment](https://docs.whop.com/api-reference/beta/experiments/create-experiment.md): Creates a draft experiment for the specified account. Use internal for a Whop platform experiment. - [Activate Experiment](https://docs.whop.com/api-reference/beta/experiments/activate-experiment.md): Starts (or resumes) an experiment or feature flag so evaluation begins serving it. Activating a draft stamps `started_at`; resuming a paused experiment keeps the original start. Only drafts and paused experiments can be activated. Requires the corresponding experiment permission on the owning accoun… - [End Experiment](https://docs.whop.com/api-reference/beta/experiments/end-experiment.md): Concludes the experiment and records required `findings`. Pass `winning_arm` to serve the winning treatment to everyone; omit it when control won. Ended experiments cannot restart, but may be ended again to correct the winner. Requires experiment:manage on the account, or internal access for platfor… - [Pause Experiment](https://docs.whop.com/api-reference/beta/experiments/pause-experiment.md): Pauses an active experiment or feature flag: evaluation stops serving it and exposures stop flowing. Assignments are keyed on stable identity, so users return to their original arm when the experiment resumes. Requires the corresponding experiment permission on the owning account, or Whop internal a… - [Update Experiment](https://docs.whop.com/api-reference/beta/experiments/update-experiment.md): Updates the targeting rules, treatment allocation, metrics, or hypothesis of an existing experiment or feature flag. Weights and metrics can only grow, so enrolled users never change arms and an existing metric is never dropped. Lifecycle moves through the transition endpoints (`activate`, `pause`,… #### Feedback - [Submit Feedback](https://docs.whop.com/api-reference/beta/feedback/submit-feedback.md): Submits an issue or an unanswered question to Whop for internal review, recorded under the authenticated user, account, or app. Returns a receipt once the submission is accepted; processing is asynchronous and no reply is sent. Accepts user, account, and app credentials. ## OpenAPI Specs - [api-v1-native](/openapi/api-v1-native.json)