Actions28
- Companies Actions
- Products Actions
- Orders Actions
- Subscriptions Actions
- Contacts Actions
- Invoices Actions
- Usage Summaries Actions
Overview
This node operation allows users to cancel a subscription by deleting it from the system via an API call. It is useful in scenarios where a user needs to programmatically terminate a subscription, for example, when a customer requests cancellation or when automating subscription lifecycle management.
Practical examples include:
- Automatically cancelling subscriptions that have expired or are no longer needed.
- Integrating with billing systems to stop recurring charges upon cancellation.
- Managing subscription states in customer relationship management workflows.
Properties
| Name | Meaning |
|---|---|
| Subscription Id | The unique identifier of the subscription to be cancelled. |
| Additional Query Parameters | Optional parameters to customize the cancellation request. Currently supports: • Cancel Date: The specific date on which the subscription should be cancelled (ISO 8601 format). |
Output
The node outputs JSON data representing the response from the subscription cancellation API. This typically includes confirmation details about the cancellation status and any relevant metadata returned by the service.
If the API supports binary data output (not indicated here), it would represent related files or documents associated with the cancellation process.
Dependencies
- Requires an API key credential for authenticating with the external subscription management service.
- The node uses a base URL endpoint
https://api.pax8.com/v1to send the cancellation request. - Proper configuration of authentication credentials within n8n is necessary to authorize API calls.
Troubleshooting
Common Issues:
- Invalid or missing Subscription Id will cause the API call to fail.
- Incorrectly formatted Cancel Date may result in rejection by the API.
- Authentication errors if the API key credential is not set or invalid.
- Network connectivity issues preventing access to the API endpoint.
Error Messages:
- "Subscription not found": Verify the Subscription Id is correct and exists.
- "Unauthorized" or "Authentication failed": Check that the API key credential is properly configured and valid.
- "Invalid date format": Ensure the Cancel Date follows ISO 8601 format.
- Timeout or network errors: Confirm network connectivity and API availability.
Links and References
- Pax8 API Documentation (for detailed API usage and parameters)
- ISO 8601 Date Format (for formatting Cancel Date)