For the complete documentation index, see llms.txt. This page is also available as Markdown.

Memberships

Enrollments linking members to the plans they are on.

List memberships

get

Returns the API key's site memberships, ordered by id and paginated with an opaque cursor. Filter by plan, member, status, and creation, renewal, or expiration date to answer questions like "which active memberships on plan X renew in the next three months."

Authorizations
AuthorizationstringRequired

Opaque Admin API key, prefixed with ms_admin_. Pass it as Authorization: Bearer ms_admin_....

Query parameters
planIdintegerOptional

Only return memberships on this plan.

memberIdintegerOptional

Only return memberships belonging to this member.

statusstring · enumOptional

Only return memberships with this status.

Possible values:
createdAfterstring · date-timeOptional

Only return memberships created on or after this ISO 8601 date-time (inclusive).

createdBeforestring · date-timeOptional

Only return memberships created before this ISO 8601 date-time (exclusive).

renewsAfterstring · date-timeOptional

Only return memberships whose billing.billingPeriodEnd is on or after this ISO 8601 date-time (inclusive).

renewsBeforestring · date-timeOptional

Only return memberships whose billing.billingPeriodEnd is before this ISO 8601 date-time (exclusive).

expiresAfterstring · date-timeOptional

Only return memberships whose expiresAt is on or after this ISO 8601 date-time (inclusive).

expiresBeforestring · date-timeOptional

Only return memberships whose expiresAt is before this ISO 8601 date-time (exclusive).

Header parameters
X-CursorstringOptional

First item to return, usually equals the previous page response's X-Next-Cursor response header. Omit to fetch the first page. Cursors are opaque tokens — do not parse or construct them.

X-Items-Afterinteger · min: 1 · max: 100Optional

Maximum number of results to return beginning with the cursor, or if not sent the first item in the list (1-100, default 25).

Default: 25
Responses
200

Successful operation

application/json
get/memberships
GET /admin/v1/memberships HTTP/1.1
Host: api.memberspace.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": 1,
    "memberId": 1,
    "planId": 1,
    "planPublicId": "text",
    "status": "active",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "type": "free",
    "expiresOn": "2026-01-01T00:00:00.000Z"
  }
]

Last updated

Was this helpful?