Retrieve a Webhook

Whop

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like `Bearer ***************************`

Authorization

The ID of the Webhook URL to search by, which will look like `hook_*************`, or the URL of the Webhook (e.g. https://website.com/api/whop-webhook)

The time at which the Product was created. Measured in seconds since the Unix epoch.

The ID of the Product, which will look like `prod_*************` or `pass_*************`

The Company this member is an Authorized User for

A number based permission system. 0 = owner, 1 = admin, 2 = moderator

The code to apply as the affiliate for the transaction. Codes are a User object's `username` field.

The ID of the session, which will look like `ch_*************`

The ID of the plan that the checkout session is associated with, which will look like `plan_*************`

The URL that the customer can use to purchase with this checkout session.

The URL the user will be navigated to after successfully completing a checkout with this session

This is the custom domain connected to a Company

The ID of the Company, which will look like `biz_*************`

The URL route of the company. It will be whop.com/{route}

The Discord account's user ID (~18 digits)

The Discord account's username, including the discriminator (Ex. John#1234)

A short description of what the Experience offers

The ID of the Experience, which will look like `exp_*************`

The Products that are connected to this Experience. By default this will just an array of IDs of these Products, but you can expand it to get more information about each Product by passing `[product]` in the `expand` parameter.

The properties of the Experience, used specifically for fields on different Experience types

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

Gives the url of the page with the user's affiliate code appended. Does not guarantee the user can affiliate anything on the page.

Whether or not this membership is scheduled to cancel at the end of the renewal period.

The ID of the checkout session (like `ch_***************`) used to purchase this membership, if any.

The time at which the Membership was created. Measured in seconds since the Unix epoch.

Questions and answers collected from the User at checkout

A hash of deliveries for this membership, as a series of key value pairs of the experience id to the delivery id. Ex. { 'exp_*************': 'dlv_*************' }

The Discord account attached to this Membership

The email of the User attached to this Membership

The time of when the Membership is set to go expired

The ID of the Membership, which will look like `mem_*************`

The URL to manage the Membership (top-up, cancel, etc.) 

The payment processor used to pay for the Membership.

The Plan attached to this Membership. By default this will just be the ID of the Plan, but you can expand it to get more information about the Plan by passing `[plan]` in the `expand` parameter.

The Product attached to this Membership. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing `[product]` in the `expand` parameter.

The Promo Code used to purchase this Membership. By default this will just be the ID of the Promo Code, but you can expand it to get more information about the Promo Code by passing `[promo_code]` in the `expand` parameter.

The amount of items included in the Membership

The UTC timestamp of when the Membership will end

The UTC timestamp of when the Membership will begin

The Stripe Customer ID attached to this Membership if it was checked out using Stripe

The Stripe Subscription ID attached to this Membership if it was checked out using Stripe

The Whop ID of their connected Telegram account, if any.

The User that owns this Membership. By default this will just be the ID of the User, but you can expand it to get more information about the User by passing `[user]` in the `expand` parameter.

Whether or not the Membership has a valid status

The crypto wallet address used to pay for the Membership (if paid through the one-time ETH or renewal WETH Whop contracts)

The smart contract that the NFT belongs to

The token you will use to authenticate your user

The current page of the paginated response

The total number of objects in the paginated response (automatically maxed out at 50)

The total number of pages in the paginated response

The amount paid to the Affiliate for this Payment

The time at which the Payment was created. Measured in seconds since the Unix epoch. Does not necessarily reflect the time the Payment was successful.

The transaction hash for the Payment if it was made with a cryptocurrency

The three letter currency the Payment was made in

The total amount paid by the User, including any discounts or taxes

The ID of the Payment, which will look like `pay_*************`

The last four digits of the credit/debit card used to make the Payment

The UTC timestamp of the last time the Payment was attempted

The Membership this Payment part of. By default this will just be the ID of the Membership, but you can expand it to get more information about the Membership by passing `[membership]` in the `expand` parameter.

The UTC timestamp of the next time the Payment will be attempted

The time at which the Payment was successfully paid at. Measured in seconds since the Unix epoch.

Which platform was used to process the Payment

The number of times the Payment has failed

The Plan this Payment is under. By default this will just be the ID of the Plan, but you can expand it to get more information about the Plan by passing `[plan]` in the `expand` parameter.

The Product this Payment is for. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing `[product]` in the `expand` parameter.

The amount that was refunded to the User (if applicable)

The UTC timestamp of the date the Payment was refunded (if applicable)

The amount paid by the User, before any discounts or taxes

The User who made the Payment. By default this will just be the ID of the User, but you can expand it to get more information about the User by passing `[user]` in the `expand` parameter.

The crypto wallet address use to make this Payment

An array of payment methods that are accepted for this Plan

How often a user will get charged for their membership (if it is a renewal plan), in number of days

Deprecated. Please use `accepted_payment_methods` instead.

The time at which the Plan was created. Measured in seconds since the Unix epoch.

A URL that targets a customer on this specific Plan

The ID of the Plan, which will look like `plan_*************`

The price to be initially charged when a user first purchases the Plan

A nickname for the Plan set by the company and not visible to the customer

Whether the Plan is a renewal or one-time purchase

The Product this Plan is tied to. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing `[product]` in the `expand` parameter.

The method the customer will use to gain access to this Plan's Product

Configurable settings on how this Plan is released.

The price to be charged for each successive billing period

Represents the different restrictions (if any) in place for purchasing the Plan

Whether or not the Plan offers unlimited stock

The Experiences that are included in this Product

The visible Plans that are included in this Product. Quick links and archived plans will not be included. There is a limit of 10 plans that can be returned for this field.

The amount off (percentage or flat amount) for the Promo Code.

The specific code used to apply the Promo Code at checkout.

The time at which the Promo Code was created. Measured in seconds since the Unix epoch.

If true, the promo code can only be applied to existing memberships (post checkout).

The date/time of when the Promo Code expires.

The ID of the Promo Code, which will look like `promo_*************`

Restricts Promo Code use to users who haven't purchased from the company before.

The number of billing cycles the Promo Code is applied for. By default, it is applied forever (0).

Please use `plans` instead, as this field is deprecated.

The Plans this Promo Code is valid for. By default this will just be the IDs of the Plans, but you can expand it to get more information about the Plan by passing `[plan]` in the `expand` parameter.

Whether the Promo Code is a percentage or flat amount off.

Indicates if the Promo Code is live, disabled, or archived.

The number of total uses remaining for the Promo Code.

Whether or not the Promo Code has unlimited uses.

The amount of times the Promo Code has been used.

The time at which the Review was created. Measured in seconds since the Unix epoch.

The body or written description of this review

The ID of the Review, which will look like `rev_*************`

The Product attached to this Review. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing `[product]` in the `expand` parameter.

The number of starts the user gave your Product

The User that made this Review. By default this will just be the ID of the User, but you can expand it to get more information about the User by passing `[user]` in the `expand` parameter.

The ID of the social account on the respective platform

The ID of the User, which will look like `user_*************`

An image URL of the User's profile photo, primarily pulled from Discord

The time at which the Webhook was created. Measured in seconds since the Unix epoch.

Whether or not the specified Webhook is enabled/turned on for new event notifications

The ID of the Webhook, which will look like `hook_*************`

The URL where new Webhook events will be sent to (e.g. https://website.com/api/whop-webhook)

The number of free days the owner of the Membership should be given

Marks whether customers can purchase multiple quantity of the Plan.

Whether or not Coinbase Commerce payments are accepted.

The interval at which the Plan charges (expiration plans).

The time period (in days) after a Membership expires where the customer can still top-up.

Marks whether or not a Plan can be purchased multiple times by a user. Used most likely for free trial plans. Default is false

An array of currencies that will be pegged to the base currency

The Plan's Product ID, which will look like `prod_*************` or `pass_*************`

Marks whether an expiration Plan can/can't be topped-up.

The number of free trial days added before a renewal Plan.

The IDs of plans associated with the Promo Code. Use JSON as your content-type when setting this. Form encoded data will not work well with arrays.

The password that must be entered to use this plan. It will automatically be appended to the `direct_link`

A key value pair of requirements.  By default, requirements will pull from the mimic_plan. Whichever ones are here will overwrite those

An array of the events the webhook will fire for. By default all events are enabled.

Update a plan using an experience access token

Marks whether paypal payments are/aren't accepted.

Whether or not a user can purchase multiple of the same Product

The number of resources to return per page. There is a limit of 50 results per page.

Whether or not license keys attached to this Product should be shuffleable by users (So if the key is leaked and the user does not want anyone else to use their key, they can have their key remade under the same membership)

Whop API

Whop Developers

API Reference

Start Selling

Introduction

How Whop Works

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.

API Documentation

OAuth

Memberships

Products

Plans

Experiences

Checkout Sessions

Companies

Customers

Members

Payments

Promo Codes

Reviews

Webhooks