Retrieve User Memberships

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

integer

default: 1

The page number to retrieve

per

integer

default: 10

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

pagination

object

Pagination model

data

object[]

data.id

string

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

data.product

string

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.

data.user

string

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.

data.plan

string

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 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.

data.email

string

The email of the User attached to this Membership

data.stripe_subscription_id

string

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

data.stripe_customer_id

string

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

data.status

enum<string>

The status of the Membership

Available options:

trialing,

active,

past_due,

completed,

canceled,

expired,

unresolved

data.valid

boolean

Whether or not the Membership has a valid status

data.cancel_at_period_end

boolean

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

data.payment_processor

enum<string>

The payment processor used to pay for the Membership.

Available options:

free,

stripe,

coinbase,

crypto,

paypal,

apple

data.license_key

string

The license key of the Membership

data.metadata

object

The metadata of the Membership

data.quantity

integer

The amount of items included in the Membership

data.wallet_address

string

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

data.custom_fields_responses

object

Questions and answers collected from the User at checkout

data.custom_fields_responses_v2

object

Questions and answers collected from the User at checkout

data.discord

object

data.nft_tokens

string

data.expires_at

integer

The time of when the Membership is set to go expired

data.renewal_period_start

integer

The UTC timestamp of when the Membership will begin

data.renewal_period_end

integer

The UTC timestamp of when the Membership will end

data.created_at

integer

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

data.manage_url

string

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

data.affiliate_page_url

string

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

data.checkout_session

string

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

data.affiliate_username

string

The username of the affiliate who referred the user to this membership, if any.

data.access_pass

string

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

data.telegram_account_id

string

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

data.phone_number

string

The phone number of the User attached to this Membership, if its allowed to be shared.

API Documentation

Apps

Company

Me

Headers

Query Parameters

Response