Cancel subscription

PATCH/subscriptions/{subscriptionId}/cancel

Cancels a subscription of the business now. There is no request body.

The API key must have write access to subscriptions, and its user must be a collaborator of the business sent in business-id. Only the business that owns the subscription can cancel it.
The cancellation takes effect immediately. Nothing is refunded.
Easyflow sends the subscription.canceled webhook once. Canceling again returns canceled and sends nothing.
Pending and charged recurrences are canceled with it (a charge in progress is canceled, a paid recurrence is not touched), and Easyflow sends one subscriptionRecurrence.canceled webhook for each of them.
A subscription that is already expired is not changed, and the response brings expired.
Up to 30 requests per minute for each user (all API keys of the same user share the limit). Above that, the API returns 429 with the Retry-After header.

Request

curl --request PATCH \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/subscriptions/SUBSCRIPTION_ID/cancel' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/subscriptions/SUBSCRIPTION_ID/cancel', {
  method: 'PATCH',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/subscriptions/SUBSCRIPTION_ID/cancel"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}

response = requests.patch(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "subscriptionId": "2d1e0f9a-8b7c-4d6e-9f5a-4b3c2d1e0f9a",
    "status": "canceled"
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 429,
  "message": "Too many requests, retry after the Retry-After seconds"
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Identifier of the business the request refers to. The user of your API key must be linked to this business, as explained in The business identifier. A value that is not a business identifier returns 400 with Invalid param: [businessId], and a business that the user is not linked to returns 403.

Path parameters

subscriptionIdstring · uuidrequired
ID of the subscription.