cancelSubscription

This will open Connect on the subscription settings page. However, it does not automatically cancel the subscription. User action is still needed. Upon successful cancellation, users will be redirected back to callbackUrl if provided.

cancelSubscription.jpg

The request expects a cancelSubscription object that defines the subscription to cancel:

Creating a Connect Session with cancelSubscription intent

$ curl --request "POST" \
--url "https://api.gigs.com/projects/${GIGS_PROJECT}/connectSessions" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${GIGS_TOKEN}" \
--data '{
  "callbackUrl": "https://example.com",
  "intent": {
    "type": "cancelSubscription",
    "cancelSubscription": {
      "subscription": "sub_0U32VAxJ0Z7P8Y40mBAnOP9LPhEr"
    }
  },
  "user": "usr_0U2ViuFW0Z7P8Y2S1L76mfADMT6m"
}'

Note: Ensure the subscription is cancelable (i.e., it has no endedAt set and is of type recurring) before creating a Connect Session, as this is not validated for you. If you redirect the user to a non-cancelable subscription, Connect will still open the subscription details view, but the cancel button will not be present. This might be confusing to users.

Where to go from here