Tool reference

    Open secure billing management

    Make an authorized change through your connected assistant.

    MCP TOOL outwrite_open_billing_portal

    outwrite_open_billing_portal

    Create a hosted billing portal session for invoices, payment methods and available subscription controls. The user authorizes changes in Stripe. Do not share this private URL with anyone else. Requires explicit user intent, confirm:true, a UUID idempotencyKey and maximumCredits for this immediate action. Recurring settings require recurringConsent:true after the user approves their ongoing costs. Retry identical arguments with the same key; inspect an uncertain receipt before any new action.

    Access and behavior

    PropertyValue
    Permissionaccount:manage
    EffectCan change your workspace

    Read the current workspace state before making a change. Respect the returned proposal, revision and operation state rather than assuming the request has finished.

    Parameters

    ParameterRequiredTypeDetails
    workspaceIdOptionalstringFormat: uuid.
    idempotencyKeyRequiredstringFormat: uuid.
    confirmRequiredbooleanValue: true.
    maximumCreditsRequirednumberMinimum 0. Maximum 100000.
    recurringConsentOptionalbooleanDefault: false.

    Complete input schema

    The schema is generated from the registered tool contract. Account permissions, revision checks and cross-field validation also apply on the server.

    Code example
    {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "idempotencyKey": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "confirm": {
          "type": "boolean",
          "const": true
        },
        "maximumCredits": {
          "type": "number",
          "minimum": 0,
          "maximum": 100000
        },
        "recurringConsent": {
          "default": false,
          "type": "boolean"
        }
      },
      "required": [
        "idempotencyKey",
        "confirm",
        "maximumCredits"
      ],
      "additionalProperties": false
    }
    

    Working safely

    For an identical retry, reuse its idempotency key. If the saved state changed, read it again and prepare a new request. An operation that is queued or running is not complete.

    See permissions and safe actions and assistant workflows.

    Need a hand with your workspace?Get help