GET
/
v5
/
company
/
memberships
Authorization
Query
curl --request GET \
  --url https://api.whop.com/api/v5/company/memberships \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "affiliate_username": "<string>",
      "cancel_at_period_end": true,
      "checkout_id": "<string>",
      "company_buyer_id": "<string>",
      "created_at": 123,
      "expires_at": 123,
      "id": "<string>",
      "license_key": "<string>",
      "manage_url": "<string>",
      "marketplace": true,
      "metadata": {},
      "page_id": "<string>",
      "plan_id": "<string>",
      "product_id": "<string>",
      "quantity": 123,
      "renewal_period_end": 123,
      "renewal_period_start": 123,
      "status": "trialing",
      "user_id": "<string>",
      "valid": true
    }
  ],
  "pagination": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
headerrequired

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

Query Parameters

statuses
enum<string>[]

An array of statuses to filter by.

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

A boolean to filter by valid memberships

product_id
string

An ID of a product to filter by, which will look like prod_*************

license_key
string

A license key to filter by.

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.

Response

200 - application/json
data
object[]
required
pagination
object
required

Was this page helpful?

OverviewRetrieve a Membership