Connectors

Preview an uninstall

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.
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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

keystring required

The connector key from the route.

Response

200 with the preview.

Example response

{
  "data": {
    "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"
    ],
    "open_support_threads": 2,
    "member_identities": 44,
    "empties_plans": true,
    "options": {
      "unpublish_emptied_plans": true,
      "cancel_recurring_subscriptions": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.