Connectors

Uninstall a connector

curl -X DELETE https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/connectors/example \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"unpublish_emptied_plans": true, "cancel_recurring_subscriptions": false}'

In order: the connector puts every member outside while its credentials still work, the rows are retired in one transaction (grants revoked, resources detached, the installation kept with uninstalled_at), the connector withdraws the installation, and the two opt-ins run. unpublish_emptied_plans (default true) takes the emptied plans off sale, firing plan.deactivated per plan; cancel_recurring_subscriptions (default true) cancels their live recurring subscriptions at the end of the paid period, firing subscription.cancelled per subscription and emailing each member that their subscription will not renew. One-time and lifetime purchases are never cancelled; a refund stays the creator's call. Identities are never removed. connector.uninstalled fires with the counts. Installing the connector again brings the same installation back as pending with its settings kept.

The two opt-ins travel in the JSON body or as query parameters; on by default, they only need sending to switch one off.

delete/v1/projects/{project}/connectors/{key}

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/connectors/{key}
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

keystring required

The connector key from the route.

Query parameters

unpublish_emptied_plansboolean

Take the plans the uninstall leaves with nothing to grant off sale, firing plan.deactivated per plan. Defaults to true; send false to leave them on sale.

cancel_recurring_subscriptionsboolean

Cancel the live recurring subscriptions on those plans at the end of their paid period, firing subscription.cancelled per subscription and emailing each member. Defaults to true; one-time and lifetime purchases are never cancelled.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Response

200 with the report.

Example response

{
  "data": {
    "connector": "example",
    "grants_revoked": 41,
    "resources_detached": 2,
    "plans_unpublished": 1
  }
}

Changes

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