Plans

Your site's plans.

List plans

get

Returns the API key's site active (non-archived) plans, ordered by id and paginated with an opaque cursor.

Authorizations

apiKey

AuthorizationstringRequired

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

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

400

Invalid request (e.g. a malformed cursor).

application/json

401

The API key is missing, unknown, revoked, or expired.

application/json

403

The request is not permitted for this API key. For example, the site's plan no longer includes Admin API access because the owner canceled or downgraded — the key itself is still valid.

application/json

404

The resource doesn't exist, or the API key lacks the scope to access it.

application/json

429

Rate limit exceeded. Wait the number of seconds in the Retry-After header before retrying.

application/json

get/plans

HTTPcURLJavaScriptPython

GET /admin/v1/plans HTTP/1.1
Host: api.memberspace.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 123,
    "publicId": "pl_aBc123",
    "name": "Premium Monthly",
    "description": "Full access to all premium content.",
    "status": "enabled",
    "isPublic": true,
    "activeMemberCount": 542,
    "colorCode": "#4F46E5",
    "contentUrl": "https://example.com/members",
    "welcomeUrl": "https://example.com/welcome",
    "createdAt": "2026-01-15T09:30:00Z",
    "updatedAt": "2026-06-01T12:00:00Z",
    "type": "subscription",
    "billingDetails": {
      "price": 29.99,
      "currency": "usd",
      "interval": {
        "count": 1,
        "unit": "month"
      },
      "billingDate": {
        "day": 1
      },
      "trialPeriodDays": 14,
      "taxPercentage": 8.5,
      "taxDescription": "Sales tax"
    }
  }
]