--- title: "Preview an uninstall" method: GET path: "/v1/projects/{project}/connectors/{key}/uninstall-preview" tags: ["Connectors"] --- # Preview an uninstall `GET /v1/projects/{project}/connectors/{key}/uninstall-preview` ## Request - Base URL: `https://api.subscriby.net` - URL: `https://api.subscriby.net/v1/projects/{project}/connectors/{key}/uninstall-preview` - Auth: HTTP bearer Uninstall deletes nothing and touches no money by itself, and it is always previewed first: ```bash 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. ## Path parameters - `project` string, uuid, required - `key` string, required ## Response `200` 200 with the preview. - object - `data` UninstallPreviewResource, required: What uninstalling a connector would touch, nothing changed: the rows beside the counts of them, and the two opt-ins with their defaults. - `installation` unknown[], required: The installation that would be uninstalled, in the installation object's shape. - unknown - `connector` string, required: The connector's key. - `resources` object[], required: The connector's places on the project; manual perks are never among them. They would be deactivated and marked detached, their external ids kept. - `id` string, required: The resource's id. - `title` string, required: The resource's title. - `kind` string, required: The resource's kind, `:`. - `active` boolean, required: Whether the resource is active today. - `live_grants` integer, required: The pending, held and granted grants on those places; each would be revoked with reason `connector_uninstalled`, firing `member.resource_removed`. - `emptied_plans` object[], required: The plans that would keep no active grantable resource. - `id` string, required: The plan's id. - `name` string, required: The plan's name. - `active` boolean, required: Whether the plan is on sale today. - `recurring` boolean, required: Whether the plan renews, so its live subscriptions could be cancelled by the opt-in. - `recurring_subscriptions` integer, required: How many live recurring purchases sit on the emptied plans. - `one_time_subscriptions` integer, required: How many live one-time or lifetime purchases sit on them; these are never cancelled. - `affected_subscription_ids` string[], required: The ids of every live purchase on the emptied plans. - `upcoming_windows` integer, required: Informational: pass windows on the connector's places that have not run yet. They are never cancelled for you; cancel them from the pass window endpoints, which handle refunds. - `open_support_threads` integer, required: Informational: open support threads that would lose their reach. - `member_identities` integer, required: Informational: member accounts linked on the connector. They are never removed. - `empties_plans` boolean, required: Whether any plan would be left with nothing to grant. - `options` object, required: The two opt-ins with their defaults, exactly the names the `DELETE` body takes. - `unpublish_emptied_plans` boolean, required: Whether the emptied plans would be taken off sale; on by default. - `cancel_recurring_subscriptions` boolean, required: Whether their live recurring subscriptions would be cancelled at the end of the paid period; on by default. ## Other responses - `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production). - `403`: `TOKEN_MISSING_ABILITY`: 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. - `404`: `RESOURCE_NOT_FOUND`: 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. - `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted. --- [API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)