OAuth
Retrieve User Memberships
Retrieve memberships possessed by the currently authenticated user as it relates to the company selling access to the specific software.
GET
/
v2
/
oauth
/
user
/
memberships
Header
Query
curl --request GET \
--url https://api.whop.com/v2/oauth/user/memberships
{
"data": [
{
"access_pass": "string",
"affiliate_page_url": "string",
"cancel_at_period_end": "boolean",
"checkout_session": "string",
"created_at": "integer",
"custom_fields_responses": "object",
"custom_fields_responses_v2": "object",
"deliveries": "object",
"discord": {
"id": "string",
"image_url": "string",
"username": "string"
},
"email": "string",
"expires_at": "integer",
"id": "string",
"license_key": "string",
"manage_url": "string",
"metadata": "object",
"nft_tokens": {
"balance": "integer",
"current_holder": "string",
"metadata": "object",
"smart_contract": {
"contract_address": "string",
"contract_name": "string"
},
"token_id": "string"
},
"payment_processor": "free",
"plan": "string",
"product": "string",
"promo_code": "string",
"quantity": "integer",
"renewal_period_end": "integer",
"renewal_period_start": "integer",
"status": "trialing",
"stripe_customer_id": "string",
"stripe_subscription_id": "string",
"telegram_account_id": "string",
"user": "string",
"valid": "boolean",
"wallet_address": "string"
}
],
"pagination": {
"current_page": "integer",
"total_count": "integer",
"total_page": "integer"
}
}
Headers
Authorization
string
A user's access token, which must be retrieved from the Whop OAuth2 authentication flow. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************
Query Parameters
page
Default: "1"integer
The page number to retrieve
per
Default: "10"integer
The number of resources to return per page. There is a limit of 50 results per page.
valid
boolean
Whether or not the Membership has a valid status
Response
200 - application/json
data
object[]
pagination
object
Pagination model
curl --request GET \
--url https://api.whop.com/v2/oauth/user/memberships
{
"data": [
{
"access_pass": "string",
"affiliate_page_url": "string",
"cancel_at_period_end": "boolean",
"checkout_session": "string",
"created_at": "integer",
"custom_fields_responses": "object",
"custom_fields_responses_v2": "object",
"deliveries": "object",
"discord": {
"id": "string",
"image_url": "string",
"username": "string"
},
"email": "string",
"expires_at": "integer",
"id": "string",
"license_key": "string",
"manage_url": "string",
"metadata": "object",
"nft_tokens": {
"balance": "integer",
"current_holder": "string",
"metadata": "object",
"smart_contract": {
"contract_address": "string",
"contract_name": "string"
},
"token_id": "string"
},
"payment_processor": "free",
"plan": "string",
"product": "string",
"promo_code": "string",
"quantity": "integer",
"renewal_period_end": "integer",
"renewal_period_start": "integer",
"status": "trialing",
"stripe_customer_id": "string",
"stripe_subscription_id": "string",
"telegram_account_id": "string",
"user": "string",
"valid": "boolean",
"wallet_address": "string"
}
],
"pagination": {
"current_page": "integer",
"total_count": "integer",
"total_page": "integer"
}
}