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": 123,
  "marketplace": true
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

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
membership found
​
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
required

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
integer | null
required

The time of when the Membership is set to go expired

​
renewal_period_start
integer | null
required

The UTC timestamp of when the Membership will begin

​
renewal_period_end
integer | null
required

The UTC timestamp of when the Membership will end

​
quantity
number
required

The quantity purchased

​
valid
boolean
required

Whether or not the membership is valid

​
cancel_at_period_end
boolean
required

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

​
metadata
object
required

The metadata for the membership

​
affiliate_username
string | null
required

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.

​
status
enum<string> | null

The status of the membership

Available options:
trialing,
active,
past_due,
completed,
canceled,
expired,
unresolved
​
license_key
string | null

The license key for the membership

​
checkout_id
string | null

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

​
company_buyer_id
number | null

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.

Was this page helpful?

List MembershipsUpdate a Membership