Skip to main content
Create a checkout session to upgrade to a new subscription tier

Tool details

FieldValue
Namecreate_subscription_upgrade
GroupSubscriptions

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "free",
        "pro",
        "enterprise"
      ],
      "description": "Subscription tier"
    },
    "cycle": {
      "type": "string",
      "enum": [
        "monthly",
        "yearly"
      ],
      "description": "Billing cycle"
    },
    "quantity": {
      "type": "integer",
      "minimum": 1,
      "description": "Seat quantity for licensed subscriptions"
    },
    "success_url": {
      "type": "string",
      "description": "Redirect URL after success"
    },
    "cancel_url": {
      "type": "string",
      "description": "Redirect URL if cancelled"
    }
  },
  "required": [
    "type",
    "cycle"
  ],
  "additionalProperties": false,
  "description": "Input schema for the create_subscription_upgrade tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Lifecycle status for the returned record."
    },
    "amount": {
      "type": [
        "string",
        "null"
      ],
      "description": "The amount associated with this tool result."
    },
    "checkout_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "The checkout url associated with this tool result."
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the create_subscription_upgrade tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}