Getting started developing an App on Whop

Installation

Whop Developers

SDK Reference

API Reference

Start Building

Build Whop apps and sell them into Whop communities with thousands of members.

Introduction

Getting started

All requests to Whop APIs are managed using a secure API key.

Get an API key

Build a ChatGPT-powered image generator and creators will be able to install it to their whops.

AI image generator

Build a chat bot on Whop that can participate in chats and forums.

Chat bot

Use webhooks to get notified when specific events happen relating to your app.

Webhooks

Learn how to implement Whop OAuth in a stand-alone application.

Login with Whop

Learn how to embed Whop's checkout flow on your website

Embed checkout (coming soon)

Learn how to implement real-time features using Whop's websocket API

Connect to websocket

Use the API to collect payment from users or payout users.

Payments and payouts

Send a push notification to a user or a group of users.

Send push notification

Create forum post

Use Whop to upload images, videos, audio, and other files.

Upload media

An overview of authentication methods for the Whop API

Authentication

Schema

Examples

Rate Limits

Overview

List Companies

Retrieve a Company

List Experiences

Retrieve an Experience

Update an Experience

List Members

Retrieve a Member

Returns a collection of memberships. By default, the valid filter is set to true.

List Memberships

Retrieve a Membership

Add Free Days to Membership

List Products

Retrieve a Product

List Payments

Retrieve a Payment

List Reviews

Retrieve a Review

Create a Notification Request

Create a notification topic for a company

Create a Notification Topic

Returns a collection of notification topics

List Notification Topics

Retrieve a Notification Topic

List Line Items

Retrieve a Line Item

Create a Line Item

Delete a Line Item

Update a Line Item

List App Connections

Retrieve an app connection

Create an App Connection

Delete an App Connection

Retrieve a User

List a User's social accounts

Create a Feed Content Item

Create a Inbound Webhook

List Inbound Webhooks

Creates a Inbound Webhook Filter

Returns a collection of inbound webhook filters

List Inbound Webhooks Filters

Retrieve an Inbound Webhook Filter

Retrieve an Experience's Inbound Webhook Filters

Retrieve the current app

This endpoint checks the given access expression.

Check Access

Update a Membership

Terminates the membership. No further payments will be made, and the customer will lose access. A terminated membership cannot be reactivated.

Terminate a Membership

Retrieve the current company

Create an OAuth Token

Retrieve the current user

Execute a webhook

Run your local setup inside of a Whop iFrame with the Whop proxy

Local development

We provide a TS client that makes it super easy to use our API. We highly recommend you use this client.

Set up the API client

Retrieve the public profile information for the currently logged in user

Retrieve current user

Use this API to ensure users have access to use your app

Validate access

Fetches an access pass based on the ID or the route

Get Access Pass

Get Attachment

Process Attachment

Upload Media

Check if the user has access to a Whop resource

Check If User Has Access To Access Pass

Check If User Has Access To Company

Check If User Has Access To Experience

Get Current User

Find Or Create Chat

List Messages From Chat

Send Message To Chat

List Direct Message Conversations

Send Direct Message To User

Get Experience

List Users For Experience

Create Forum Post

Find Or Create Forum

List Forum Posts From Forum

Send Push Notification

Charge User

Get Company Ledger Account

Get User Ledger Account

Pay User

Get User

Getting Started

Open external links from within the iFrame

Open External Links

Redirect URLs

Returns a collection of Memberships, based on the supplied filters. If a Membership is valid, the User has/should have access to the Experiences associated with the Product. If a Membership is invalid, the User will/should have their Product's Experiences unfulfilled. By default, results are returned 10 objects at a time.

Validate an instance of your software by sending metadata about the user. For example, by sending metadata containing the HWID of the device most recently logged in, you can ensure an instance of your software is only being used on one device at a time.

Validate a License Key

Returns a specific Membership, using its unique ID. A Membership represents an instance of a User purchasing a Product.

Terminates a specific Membership, using its unique ID. It will immediately invalidate the Membership, and the User will/should have their Product's Experiences unfulfilled. Termination is irreversible, so a User will have to re-purchase if they wish to continue their access.

Use the update license endpoint to add metadata like hwid to an instance of the License.

Cancels a specific Membership, using its unique ID. It will set the Membership to cancel at period end.

Cancel a Membership

Extend a Membership's next renewal date or expiration date by a specified number of days. Once the Membership's updated renewal/expiration date has been reached, it will renew or expire as normal.

Add Free Days to a Membership

Returns a collection of Products, based on the supplied filters.

Returns a specific Product, using its unique ID.

Update a Product's attributes, using its unique ID. Keep in mind, any changes made to the pass will be reflected on the User's account.

Update a Product

Returns a collection of Plans, based on the supplied filters. Plans represent a pricing and release method configuration used to purchase a Product.

List Plans

Returns a specific Plan, using its unique ID. Plans represent a pricing and release method configuration used to purchase a Product.

Retrieve a Plan

Update a Plan

Create a plan

Create a quick link (or release link) for a plan. This will copy over all data from an existing plan and make a new plan with the same data that can be used as a one-time release link. You can change the stock and metadata on the new plan.

Create a quick link

Returns a collection of Experiences, based on the supplied filters. Experiences represent what the customer receives or unlocks when they purchase an Product. By default, results are returned 10 objects at a time

Returns a specific Experience, using its unique ID. Experiences represent what the customer receives or unlocks when they purchase a Membership.

Delete an Experience

Creates a new Checkout Session. A Checkout Session allows specific data to be attached to a Membership upon purchase and customization of the checkout experience.

Create a Checkout Session

Returns a collection of Checkout Sessions, based on the supplied filters. By default, results are returned 10 objects at a time.

Retrieve a Checkout Session

List Checkout Sessions

Deletes a specific Checkout Session, using its unique ID.

Delete a Checkout Session

Returns the Company that is attached the the API key.

Returns a list of all your members. Members are users who have a currently active membership.

Retrieve Member

Returns a collection of Payments, based on the supplied filters. Only Payments with a status of paid have been successfully processed.

Returns a specific Payment, using its unique ID. Only Payments with a status of paid have been successfully processed.

Returns a collection of Payment Fees for a given payment.

List Payment Fees

List Promo Codes

Retrieve a promo code

Update a promo code

Creates a new promo code with the given parameters. A promo code can offer a discount or a free period for a specific set of plans or for all plans in your company.

Create a promo code

Delete a promo code. You can only delete a promo code that has not been used yet. We recommend using the update endpoint and setting its status to 'archived' over this.

Getting started

Authentication

Resources

iFrame