How Whop Works

Whop

Whop Developers

API Reference

Start Selling

Introduction

Learn the differences between OAuth and License Keys, and which one is best for selling access to your application.

How to sell access to your application

License Keys - Desktop Software

OAuth - Webapps

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

Overview

Understanding the various webhook events available to you

Examples

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

Templates

Learn how to use the Whop API to restrict access to Discord bot commands. Ensure only users with a valid membership can use the commands.

Discord Bots

General Documentation

Developer Discord

Whop Blog

An overview of authentication methods for the Whop API

Authentication

This is how you obtain an access token for a user. In the OAuth flow, your backend will receive a one time use "code" parameter. You will then exchange the code you received for a long lived access token by calling this endpoint.

Obtain a user's access token

Retrieves the user object that for the authenticated user.

Retrieve User

Retrieve memberships possessed by the currently authenticated user as it relates to the company selling access to the specific software.

Retrieve User Memberships

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.

List Memberships

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.

Retrieve a Membership

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.

Terminate a Membership

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

Update a Membership

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.

List Products

Returns a specific Product, using its unique ID.

Retrieve a Product

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

List Experiences

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

Retrieve an Experience

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.

Retrieve a Company

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

List Customers

Retrieve Customer

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.

List Payments

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

Retrieve a Payment

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

Selling your software

Webhooks

More

How Whop Works

Products

Experiences

Marketplace