GET
/
v5
/
company
/
memberships
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v5/company/memberships/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "product_id": "<string>",
  "user_id": "<string>",
  "plan_id": "<string>",
  "page_id": "<string>",
  "created_at": 123,
  "expires_at": 123,
  "renewal_period_start": 123,
  "renewal_period_end": 123,
  "quantity": 123,
  "status": "trialing",
  "valid": true,
  "cancel_at_period_end": true,
  "license_key": "<string>",
  "metadata": {},
  "checkout_id": "<string>",
  "affiliate_username": "<string>",
  "manage_url": "<string>",
  "company_buyer_id": "<string>",
  "marketplace": true
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the Membership, which will look like mem_*************. This can also be the license key

Response

200 - application/json
id
string
required

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

product_id
string
required

The ID of the product, which will look like prod_*************

user_id
string

The ID of the user, which will look like user_*************

plan_id
string
required

The ID of the plan, which will look like plan_*************

page_id
string
required

The ID of the page, which will look like page_*************

created_at
number
required

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

expires_at
number

The time of when the Membership is set to go expired

renewal_period_start
number

The UTC timestamp of when the Membership will begin

renewal_period_end
number

The UTC timestamp of when the Membership will end

quantity
number
required

The quantity purchased

status
enum<string>
required

The status of the membership

Available options:
trialing,
active,
past_due,
completed,
canceled,
expired,
unresolved
valid
boolean
required

Whether or not the membership is valid

cancel_at_period_end
boolean

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

license_key
string

The license key for the membership

metadata
object

The metadata for the membership

checkout_id
string

The ID of the checkout used to first purchase / generate the membership.

affiliate_username
string

The username of the affiliate that referred the customer to this membership, if any.

manage_url
string
required

The URL for the customer to manage their membership on whop.com.

company_buyer_id
string

The ID of the company that purchased/owns the membership. (For example, they installed an app). Looks like biz_*************

marketplace
boolean

Whether or not the membership was purchased through the whop marketplace.