Sign in
Memberships

List Memberships

Lists every membership the caller can read: an account API key its account's; a user credential their own plus those of every account they manage. account_id and user_id only narrow that list — values outside the caller's reach return fewer results, not an error.

get/memberships

Query parameters

account_idstring

Narrow to one account (biz_ tag). With read access to the account this lists all of its memberships; without, only the caller's own memberships in it.

user_idstring

Narrow to one user's memberships (user_ tag, or me for the caller). A user outside the caller's visible set returns an empty list.

status'active' | 'trialing' | 'past_due' | 'completed' | 'canceled' | 'expired' | 'canceling' | 'paused'

Filter by billing state. canceling matches active memberships set to cancel at period end; paused matches memberships with payment collection paused.

product_idstring

Filter to memberships of this product (prod_ tag). Repeat as product_ids[] for several.

plan_idstring

Filter to memberships of this plan (plan_ tag). Repeat as plan_ids[] for several.

created_afterstring

Only memberships created after this ISO 8601 timestamp.

created_beforestring

Only memberships created before this ISO 8601 timestamp.

order'created_at'

Sort field.

direction'asc' | 'desc'

Sort direction.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

memberships listed

Example response

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "route": "shine-time-auto-detailing",
        "title": "Shine Time Auto Detailing"
      },
      "cancel_at_period_end": true,
      "canceled_at": "2026-01-01T12:00:00.000Z",
      "cancellation_reason": "Too expensive",
      "created_at": "2026-01-01T12:00:00.000Z",
      "current_period_end": "2026-01-01T12:00:00.000Z",
      "current_period_start": "2026-01-01T12:00:00.000Z",
      "id": "mem_xxxxxxxxxxxxxx",
      "license_key": "WHOP-XXXX-XXXX-XXXX",
      "manage_url": "https://whop.com/billing/manage/mber_xxxxxxxxxxxxxx",
      "member": {
        "access_level": "customer",
        "last_accessed_at": "2026-01-01T12:00:00.000Z",
        "position": 1767268800000
      },
      "metadata": {},
      "phone_number": "+xxxxxxxxxxx",
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "product_id": "prod_xxxxxxxxxxxxxx",
      "status": "active",
      "user_id": "user_xxxxxxxxxxxxxx"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes