Cancel subscription

Cancels a subscription using the supplied cancellation request.

Supported cancellation types:

PeriodEnd - Cancel subscription at the end of the billing cycle
Immediate - Cancel subscription immediately
Date - Cancel at specified ‘CancelAt’ date

If not supplied, PeriodEnd is used and the subscription is cancelled at the end of the billing cycle.

Default behaviour:

If the subscription is trialing a tier, the tier is reverted to the previous tier at the end of the trials duration. This is only supported with PeriodEnd CancellationType.
If the subscription is trialing add-on(s), the add-on is removed at the end of the trials duration. This is only supported with PeriodEnd CancellationType.

Important considerations:

If ‘cancelSubscription’ is specified and set to ‘true’, the default behaviour specified above is ignored and the cancellation is applied directly on the subscription.

PATCH

subscriptions

{id}

cancel

curl --request PATCH \
  --url https://api.smokeball.com/subscriptions/{id}/cancel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "cancellationType": "<string>",
  "cancelAt": "2023-11-07T05:31:56Z",
  "cancelSubscription": true,
  "reason": "<string>",
  "preview": true
}'

{
  "preview": true,
  "cancellationType": "<string>",
  "cancellationBehaviour": "<string>",
  "cancelAt": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "tier": {
    "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET",
    "self": {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    },
    "smokeballId": "<string>",
    "productSuite": "<string>",
    "name": "Intake",
    "description": "<string>",
    "trialPeriodDays": 123,
    "prices": [
      {
        "default": true,
        "active": true,
        "type": "Recurring",
        "name": "\"$109 per user/month\"",
        "amount": 5900,
        "interval": "Monthly"
      }
    ],
    "createdDate": "2022-04-23T14:00:00Z",
    "updatedDate": "2022-04-23T14:00:00Z"
  },
  "addOns": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "smokeballId": "<string>",
      "productSuite": "<string>",
      "name": "Intake",
      "description": "<string>",
      "trialPeriodDays": 123,
      "prices": [
        {
          "default": true,
          "active": true,
          "type": "Recurring",
          "name": "\"$109 per user/month\"",
          "amount": 5900,
          "interval": "Monthly"
        }
      ],
      "createdDate": "2022-04-23T14:00:00Z",
      "updatedDate": "2022-04-23T14:00:00Z"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Path Parameters

string

required

The unique identifier of the subscription

Body

Response

200

application/json

Successfully cancelled the subscription

The response is of type object.

curl --request PATCH \
  --url https://api.smokeball.com/subscriptions/{id}/cancel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "cancellationType": "<string>",
  "cancelAt": "2023-11-07T05:31:56Z",
  "cancelSubscription": true,
  "reason": "<string>",
  "preview": true
}'

{
  "preview": true,
  "cancellationType": "<string>",
  "cancellationBehaviour": "<string>",
  "cancelAt": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "tier": {
    "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET",
    "self": {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    },
    "smokeballId": "<string>",
    "productSuite": "<string>",
    "name": "Intake",
    "description": "<string>",
    "trialPeriodDays": 123,
    "prices": [
      {
        "default": true,
        "active": true,
        "type": "Recurring",
        "name": "\"$109 per user/month\"",
        "amount": 5900,
        "interval": "Monthly"
      }
    ],
    "createdDate": "2022-04-23T14:00:00Z",
    "updatedDate": "2022-04-23T14:00:00Z"
  },
  "addOns": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "smokeballId": "<string>",
      "productSuite": "<string>",
      "name": "Intake",
      "description": "<string>",
      "trialPeriodDays": 123,
      "prices": [
        {
          "default": true,
          "active": true,
          "type": "Recurring",
          "name": "\"$109 per user/month\"",
          "amount": 5900,
          "interval": "Monthly"
        }
      ],
      "createdDate": "2022-04-23T14:00:00Z",
      "updatedDate": "2022-04-23T14:00:00Z"
    }
  ]
}

Cancel subscription

Cancels a subscription using the supplied cancellation request.

Supported cancellation types:

PeriodEnd - Cancel subscription at the end of the billing cycle
Immediate - Cancel subscription immediately
Date - Cancel at specified ‘CancelAt’ date

If not supplied, PeriodEnd is used and the subscription is cancelled at the end of the billing cycle.

Default behaviour:

If the subscription is trialing a tier, the tier is reverted to the previous tier at the end of the trials duration. This is only supported with PeriodEnd CancellationType.
If the subscription is trialing add-on(s), the add-on is removed at the end of the trials duration. This is only supported with PeriodEnd CancellationType.

Important considerations:

If ‘cancelSubscription’ is specified and set to ‘true’, the default behaviour specified above is ignored and the cancellation is applied directly on the subscription.

PATCH

subscriptions

{id}

cancel

curl --request PATCH \
  --url https://api.smokeball.com/subscriptions/{id}/cancel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "cancellationType": "<string>",
  "cancelAt": "2023-11-07T05:31:56Z",
  "cancelSubscription": true,
  "reason": "<string>",
  "preview": true
}'

{
  "preview": true,
  "cancellationType": "<string>",
  "cancellationBehaviour": "<string>",
  "cancelAt": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "tier": {
    "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET",
    "self": {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    },
    "smokeballId": "<string>",
    "productSuite": "<string>",
    "name": "Intake",
    "description": "<string>",
    "trialPeriodDays": 123,
    "prices": [
      {
        "default": true,
        "active": true,
        "type": "Recurring",
        "name": "\"$109 per user/month\"",
        "amount": 5900,
        "interval": "Monthly"
      }
    ],
    "createdDate": "2022-04-23T14:00:00Z",
    "updatedDate": "2022-04-23T14:00:00Z"
  },
  "addOns": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "smokeballId": "<string>",
      "productSuite": "<string>",
      "name": "Intake",
      "description": "<string>",
      "trialPeriodDays": 123,
      "prices": [
        {
          "default": true,
          "active": true,
          "type": "Recurring",
          "name": "\"$109 per user/month\"",
          "amount": 5900,
          "interval": "Monthly"
        }
      ],
      "createdDate": "2022-04-23T14:00:00Z",
      "updatedDate": "2022-04-23T14:00:00Z"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Path Parameters

string

required

The unique identifier of the subscription

Body

Response

200

application/json

Successfully cancelled the subscription

The response is of type object.

curl --request PATCH \
  --url https://api.smokeball.com/subscriptions/{id}/cancel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "cancellationType": "<string>",
  "cancelAt": "2023-11-07T05:31:56Z",
  "cancelSubscription": true,
  "reason": "<string>",
  "preview": true
}'

{
  "preview": true,
  "cancellationType": "<string>",
  "cancellationBehaviour": "<string>",
  "cancelAt": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "tier": {
    "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET",
    "self": {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    },
    "smokeballId": "<string>",
    "productSuite": "<string>",
    "name": "Intake",
    "description": "<string>",
    "trialPeriodDays": 123,
    "prices": [
      {
        "default": true,
        "active": true,
        "type": "Recurring",
        "name": "\"$109 per user/month\"",
        "amount": 5900,
        "interval": "Monthly"
      }
    ],
    "createdDate": "2022-04-23T14:00:00Z",
    "updatedDate": "2022-04-23T14:00:00Z"
  },
  "addOns": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "smokeballId": "<string>",
      "productSuite": "<string>",
      "name": "Intake",
      "description": "<string>",
      "trialPeriodDays": 123,
      "prices": [
        {
          "default": true,
          "active": true,
          "type": "Recurring",
          "name": "\"$109 per user/month\"",
          "amount": 5900,
          "interval": "Monthly"
        }
      ],
      "createdDate": "2022-04-23T14:00:00Z",
      "updatedDate": "2022-04-23T14:00:00Z"
    }
  ]
}