Preview an uninstall

/v1/projects/{project}/connectors/{key}/uninstall-preview in the Connectors API.

Uninstall deletes nothing and touches no money by itself, and it is always previewed first:

curl https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/connectors/example/uninstall-preview \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

resources are the connector's on the project (manual perks are never among them); they will be deactivated and marked detached, their external ids kept.
live_grants are the pending, held and granted grants on those resources; each is revoked with reason connector_uninstalled and fires member.resource_removed.
emptied_plans are the plans that would keep no active grantable resource; recurring_subscriptions and one_time_subscriptions are the live purchases on them, affected_subscription_ids names them.
upcoming_windows, open_support_threads and member_identities are informational: pass windows are never cancelled for you (cancel them from the pass window endpoints, which handle refunds), support threads lose their reach, and member accounts are never removed.
options are the two opt-ins with their defaults, exactly the names the DELETE takes.

Requires ability

project-connector:view

The token must hold this ability, or the call is refused with 403.

MCP tool

get_connector_uninstall_preview

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

key*string

The connector key from the route.

Responses

200OKapplication/json

200 with the preview.

data*

The response's payload.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred. On this endpoint: RESOURCE_NOT_FOUND: with reason: unknown_connector, or 404 CONNECTOR_NOT_INSTALLED when the project does not run the connector.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/connectors/string/uninstall-preview"

{  "data": {    "installation": {      "id": "3b8f0c6e-2d41-4a97-9e5f-1c7d6b2a8e40",      "connector": "example",      "state": "connected",      "operational": true    },    "connector": "example",    "resources": [      {        "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",        "title": "Members Lounge",        "kind": "example: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    }  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: UninstallPreviewResource;}export interface UninstallPreviewResource {  installation: unknown[];  connector: string;  resources: Resource[];  live_grants: number;  emptied_plans: EmptiedPlan[];  recurring_subscriptions: number;  one_time_subscriptions: number;  affected_subscription_ids: string[];  upcoming_windows: number;  open_support_threads: number;  member_identities: number;  empties_plans: boolean;  options: Options;}export interface Resource {  id: string;  title: string;  kind: string;  active: boolean;}export interface EmptiedPlan {  id: string;  name: string;  active: boolean;  recurring: boolean;}export interface Options {  unpublish_emptied_plans: boolean;  cancel_recurring_subscriptions: boolean;}

Preview an uninstall

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Authorization

Path Parameters

Responses