Skip to main content
Get the current user’s subscription details including tier, status, and expiration

Tool details

FieldValue
Nameget_subscription
GroupBilling & Usage

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "description": "Input schema for the get_subscription tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "user_id": {
      "type": "string",
      "description": "The user id associated with this tool result."
    },
    "project_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Project identifier associated with this result."
    },
    "line_items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "plan",
              "seat",
              "server",
              "sandbox"
            ],
            "description": "The kind associated with this tool result."
          },
          "quantity": {
            "type": "number",
            "description": "The quantity associated with this tool result."
          }
        },
        "required": [
          "kind",
          "quantity"
        ],
        "additionalProperties": false,
        "description": "One line item item associated with this tool result."
      },
      "description": "The line items associated with this tool result."
    },
    "status": {
      "type": "string",
      "description": "Lifecycle status for the returned record."
    },
    "current_period_start": {
      "type": [
        "string",
        "null"
      ],
      "description": "The current period start associated with this tool result."
    },
    "current_period_end": {
      "type": [
        "string",
        "null"
      ],
      "description": "The current period end associated with this tool result."
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The expires at associated with this tool result."
    },
    "canceled_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The canceled at associated with this tool result."
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    }
  },
  "additionalProperties": false,
  "description": "Structured result returned by the get_subscription tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}