Update subscription

veryfront__update_subscription

Requires account.billing.manage.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
typestringYesSubscription tier to upgrade to. Values: "free", "pro", "enterprise".
cyclestringYesBilling cycle Values: "monthly", "yearly".
quantityintegerNoSeat quantity for licensed subscriptions Minimum: 1.
server_quantityintegerNoRecurring server add-on quantity Minimum: 0.
sandbox_quantityintegerNoRecurring sandbox add-on quantity Minimum: 0.
success_urlstringNoURL to redirect to after successful payment Format: uri.
cancel_urlstringNoURL to redirect to if payment is canceled. Format: uri.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__update_subscription",
    "arguments": {
      "type": "free",
      "cycle": "monthly"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
statusstringYesWhat the update did. checkout_created means payment is required at checkout_url. Values: "subscription_updated", "seats_updated", "add_ons_updated", "checkout_created".
amountstring or nullYesExact decimal amount due, without a currency suffix. Null when no amount is due or known.
currencystring or nullYesISO 4217 currency of amount in upper case. Null without an amount.
checkout_urlstring or nullYesStripe checkout session URL when payment is required. Null when the change was applied in place.

Full schemas

json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "free",
        "pro",
        "enterprise"
      ],
      "description": "Subscription tier to upgrade to."
    },
    "cycle": {
      "type": "string",
      "enum": [
        "monthly",
        "yearly"
      ],
      "description": "Billing cycle"
    },
    "quantity": {
      "type": "integer",
      "minimum": 1,
      "description": "Seat quantity for licensed subscriptions"
    },
    "server_quantity": {
      "type": "integer",
      "minimum": 0,
      "description": "Recurring server add-on quantity"
    },
    "sandbox_quantity": {
      "type": "integer",
      "minimum": 0,
      "description": "Recurring sandbox add-on quantity"
    },
    "success_url": {
      "type": "string",
      "format": "uri",
      "description": "URL to redirect to after successful payment"
    },
    "cancel_url": {
      "type": "string",
      "format": "uri",
      "description": "URL to redirect to if payment is canceled."
    }
  },
  "required": [
    "type",
    "cycle"
  ],
  "additionalProperties": false,
  "description": "Arguments for the update_subscription tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "subscription_updated",
        "seats_updated",
        "add_ons_updated",
        "checkout_created"
      ],
      "description": "What the update did. `checkout_created` means payment is required at `checkout_url`."
    },
    "amount": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^-?\\d+(?:\\.\\d+)?$"
        },
        {
          "type": "null",
          "description": "The amount returned by the tool."
        }
      ],
      "description": "Exact decimal amount due, without a currency suffix. Null when no amount is due or known."
    },
    "currency": {
      "type": [
        "string",
        "null"
      ],
      "description": "ISO 4217 currency of `amount` in upper case. Null without an amount."
    },
    "checkout_url": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "type": "null",
          "description": "The checkout url returned by the tool."
        }
      ],
      "description": "Stripe checkout session URL when payment is required. Null when the change was applied in place."
    }
  },
  "required": [
    "status",
    "amount",
    "currency",
    "checkout_url"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the update_subscription tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}