Get Workspace Subscription

{
  "data": {
    "id": "string",
    "plan": {
      "id": "string",
      "plan_group_id": "string",
      "name": "string",
      "tier": "free",
      "limits": {},
      "display_order": 1,
      "plan_details": {
        "sections": [
          {
            "title": "string",
            "items": [
              {
                "label": "string",
                "value": "string",
                "included": true
              }
            ]
          }
        ]
      },
      "plan_price_id": "string",
      "billing_interval": "string",
      "amount": 1,
      "currency": "string",
      "is_popular": false,
      "support_channels": "string",
      "soc2_report_shared": true
    },
    "status": "string",
    "current_period_start": "2024-01-15T09:30:00Z",
    "current_period_end": "2024-01-15T09:30:00Z",
    "cancel_at_period_end": true,
    "canceled_at": "2024-01-15T09:30:00Z",
    "scheduled_plan": {
      "id": "string",
      "plan_group_id": "string",
      "name": "string",
      "tier": "free",
      "limits": {},
      "display_order": 1,
      "plan_details": {
        "sections": [
          {
            "title": "string",
            "items": [
              {
                "label": "string",
                "value": "string",
                "included": true
              }
            ]
          }
        ]
      },
      "plan_price_id": "string",
      "billing_interval": "string",
      "amount": 1,
      "currency": "string",
      "is_popular": false,
      "support_channels": "string",
      "soc2_report_shared": true
    },
    "scheduled_at": "2024-01-15T09:30:00Z"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2024-01-15T09:30:00Z"
  }
}

The active subscription governing THIS workspace — the workspace-scoped counterpart of /users/me/subscription.

Personal workspace → the owning user’s subscription, readable only by the owner; org workspace → the organization’s subscription (or null on free tier), readable by any member or an org admin. Use this instead of /users/me/subscription when rendering a workspace’s plan, so an org workspace shows the ORGANIZATION’s plan. Membership is existence-hidden (404); the org-admin fallback applies (an org admin with no materialized member row can still read).

The active subscription governing THIS workspace — the workspace-scoped counterpart of ``/users/me/subscription``. Personal workspace → the owning user's subscription, readable **only by the owner**; **org** workspace → the **organization's** subscription (or ``null`` on free tier), readable by any member or an org admin. Use this instead of ``/users/me/subscription`` when rendering a workspace's plan, so an org workspace shows the ORGANIZATION's plan. Membership is existence-hidden (404); the org-admin fallback applies (an org admin with no materialized member row can still read).

Authentication

AuthorizationBearer

Clerk JWT token

Path parameters

workspace_idstringRequiredformat: "uuid"

Response

Successful Response

dataobject or null

metaobject

Errors

422

Unprocessable Entity Error