Whop Business API
Search…
🎟
Licenses
This page is an overview of the Whop API Licenses endpoints
The Fetch License, Update License, Validate License, and Reset License endpoints can all be called with client ID instead of a bearer token.
​
To do this pass in a header "Authorization" with the value as your client ID.
You can use Licenses to grant your end user a copy of your software.
get
https://api.whop.com/api
/v1/licenses/{key}
Fetch License
Use the update license endpoint to add metadata like hwid to an instance of the License. This can help you track things like user preferences and the device a user is using your software from.
patch
https://api.whop.com/api
/v1/licenses/{key}
Update License
Validate an instance of your software by sending metadata about the user. For example, sending the hwid of the device the user logged in from can help you ensure an instance of your software is only being used on one device.
A valid key is one whose key_status is either approved or listed, and whose subscription_status is either completed, active, or trialing. It is up to your auth system to determine if hwid is already set. A key that returns value: true does not necessarily mean that they should be let into the program.
post
https://api.whop.com/api
/v1/licenses/{key}/validate
Validate License
Upon successful reset, all metadata associated with the license will be reset.
By default only the values hwid and userHash are removed. If you would like to reset all metadata on a license, please reach out to us and we can perform a full metadata reset.
post
https://api.whop.com/api
/v1/licenses/{key}/reset
Reset License
Set a license to banned: true. When banned, the license will return valid: false.
post
https://api.whop.com/api
/v1/licenses/{key}/ban
Ban License
get
https://api.whop.com/api
/v1/licenses
Fetch All Licenses

Key Status

key_status
Description
pending
Pending implies that a key is waiting to be verified by a user linking their Discord account. If you have imported your licenses from a prior dashboard, the statuses will be pending until claimed by the rightful user.
approved
An approved status is one that is a valid key and can be listed for sale (if your company offers an aftermarket).
listed
Key is currently listed for rent via public marketplace.
removed
Key has been removed by customer.
sold
Key has been sold to a different customer.
terminated
Key has been terminated and should no longer be used.
expired
Key with an expiring plan type has been expired and should no longer be used.
disabled
Disabled by an admin via dash.
​
Copy link
On this page
get
Fetch License
patch
Update License
post
Validate License
post
/v1/licenses/{key}/reset
post
/v1/licenses/{key}/ban
get
Fetch All Licenses
Key Status