Retrieve a Membership
Returns a membership
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The ID of the Membership, which will look like mem_*************. This can also be the license key
Response
The ID of the membership, which will look like mem_*************
The ID of the product, which will look like prod_*************
The ID of the user, which will look like user_*************
The ID of the plan, which will look like plan_*************
The ID of the page, which will look like page_*************
The time at which the Membership was created. Measured in seconds since the Unix epoch.
The time of when the Membership is set to go expired
The UTC timestamp of when the Membership will begin
The UTC timestamp of when the Membership will end
The quantity purchased
The status of the membership
trialing
, active
, past_due
, completed
, canceled
, expired
, unresolved
Whether or not the membership is valid
Whether or not this membership is scheduled to cancel at the end of the renewal period.
The license key for the membership
The metadata for the membership
The ID of the checkout used to first purchase / generate the membership.
The username of the affiliate that referred the customer to this membership, if any.
The URL for the customer to manage their membership on whop.com.
The ID of the company that purchased/owns the membership. (For example, they installed an app). Looks like biz_*************
Whether or not the membership was purchased through the whop marketplace.
Was this page helpful?