get_connector_uninstall_preview

Show what uninstalling a connector from a project would touch, changing nothing — the dialog to confirm before uninstall_connector.

Purpose

The impact preview the Connectors tab shows before an uninstall, for an agent to read back to the creator. Nothing changes: it lists the connector's resources (which would be deactivated as detached), counts the live_grants on them (which would be revoked and their members put outside), names the emptied_plans that would keep nothing to grant, counts the recurring_subscriptions on those plans (which the creator may have cancelled at period end) and the one_time_subscriptions (never cancelled), lists affected_subscription_ids, and counts the upcoming_windows of emptied pass plans, the open_support_threads on the connector and the member_identities that would lose their reach. options carries the two opt-ins with their defaults. The REST twin is GET /v1/projects/{project}/connectors/{key}/uninstall-preview.

Required ability

project-connector:view

Input schema

{
  "type": "object",
  "required": ["project_id", "connector"],
  "properties": {
    "project_id": {
      "type": "string",
      "description": "UUID of the project."
    },
    "connector": {
      "type": "string",
      "description": "The connector key, as list_connectors returns it."
    }
  }
}

Output shape

{
  "data": {
    "installation": { "id": "3b8f0c6e-2d41-4a97-9e5f-1c7d6b2a8e40", "connector": "discord", "state": "connected", "operational": true },
    "connector": "discord",
    "resources": [
      { "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6", "title": "Members Lounge", "type": null, "kind": "discord:role", "active": true }
    ],
    "live_grants": 41,
    "emptied_plans": [
      { "id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b", "name": "Lounge Monthly", "active": true, "recurring": true }
    ],
    "recurring_subscriptions": 17,
    "one_time_subscriptions": 3,
    "affected_subscription_ids": ["5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4"],
    "upcoming_windows": 0,
    "open_support_threads": 2,
    "member_identities": 44,
    "empties_plans": true,
    "options": {
      "unpublish_emptied_plans": true,
      "cancel_recurring_subscriptions": true
    }
  },
  "meta": {}
}

Example prompts

"What would happen if I removed Discord from Research Premium?"

Failure modes

AUTHENTICATION_REQUIRED — no authenticated user on the request.
TOKEN_MISSING_ABILITY — token lacks project-connector:view.
RESOURCE_NOT_FOUND — the project is not visible to this token, or context.reason is unknown_connector.
CONNECTOR_NOT_INSTALLED — the project has no installation of the connector.

uninstall_connector — the act this previews.
disconnect_connector — the reversible alternative.
Connectors API