Whop Developers

API Reference

SDK Reference

Start Building

Information about all the different app views, and variables available to them.

App views

Introduction

Before you start planning and developing your app, it’s important to understand what Whop apps do and how they fit into Whop.

Apps Overview

You're ready to create a new app. You want to set up your development environment so that you can start coding.

Create an app

After you create an app, you will build out the page that allows Whop Companies to interact with your app

Build your seller page

If your app is built for businesses to sell to customers, then it's time to build your customer page

Build your customer page

How to create an app that is displayed alongside the checkout page.

Build your checkout page

Now that your app is built out, it's time to deploy

Deploying your app

Downloadable Software

Web Apps

Send a notification to your users using the Notifications API.

Send a notification

Learn how to add in-app purchases to your app.

In-App Purchases

Metered billing allows an app developer to charge a seller. This is one of the ways developers can make money selling apps

Metered Billing

Video App

Email app

A guide to using webhooks for real-time notifications and integrations

Overview

This page contains examples of how to use Whop to sell access to your software.

Templates

Contribute

Branding

App Devs Office Hours

An overview of authentication methods for the Whop API

Authentication

Rate Limits

List Companies

Retrieve a Company

List Experiences

Retrieve an Experience

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

Send a Notification

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

List Billing Usages

Retrieve a Billing Usage

Create a Billing Usage

Delete a Billing Usage

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

Create a Billing Item

List Billing Items

Retrieve a Billing Item

Update a Billing Item

Retrieve the current company

Create an OAuth Token

Retrieve the current user

Getting started developing an App on Whop

Installation

Whop Proxy

hasAccess

Validate Token

Fetch Token

Use the SDK to use our API and return it in a formatted JSON response

Whop API

Receiving Webhooks

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.

Update an Experience

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.

List Members

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.

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.

View	Description	Example
`customer`	The view that customers see on whop.com when accessing a product	Displaying sports picks to paying users
`checkout`	Displayed before the customer pays for the product	Collecting information about a user such as their Twitter
`seller_product`	Accessible by the seller when they are editing a product	Uploading a file that the user can download for that specific product
`seller`	Accessible by the seller in the apps page on the dashboard	Displaying detailed analytics about their company

Views	Description
`productId`	The ID of the product the user purchased
`companyId`	The ID of the company the user purchased the product from
`experienceId`	The ID of the experience
`membershipId`	The ID of the user’s membership
`planId`	The ID of the plan the user purchased

Parameter	Description
`companyId`	The ID of the company
`checkoutSessionId`	The ID of the checkout session
`productId`	The ID of the product
`planId`	The ID of the plan

Parameter	Description
`companyId`	The ID of the company
`productId`	The ID of the product
`experienceId`	The ID of the experience

Getting Started

What can I sell with Whop?

Whop App Guides

Webhooks

More

App views

Customer View

Variables

Checkout View

Variables

Seller Product View

Variables

Seller View

Variables

Getting Started

What can I sell with Whop?

Whop App Guides

Webhooks

More

​Customer View

​Variables

​Checkout View

​Variables

​Seller Product View

​Variables

​Seller View

​Variables

Customer View

Variables

Checkout View

Variables

Seller Product View

Variables

Seller View

Variables