Actions115
- Course Actions
- Bundle Actions
- Course Grade Actions
- Course Grade Detail Actions
- Course Teacher Actions
- Email Actions
- Email Campaign Actions
- Email Campaign Course Actions
- Email Campaign Excluded Course Actions
- Email Campaign Excluded List Actions
- Enroll Actions
- Email Campaign Excluded Plan Actions
- Email Campaign List Actions
- Email Campaign Plan Actions
- Email List Actions
- MindzPay Account Actions
- MindzPay Invoice Actions
- MindzPay Payment Actions
- MindzPay Subscription Actions
- Subscription Actions
- Team Actions
- User Actions
Overview
The MindzPay Subscription Suspend operation allows users to suspend an active subscription within the MindzPay system. This node is useful in scenarios where a subscription needs to be temporarily halted without canceling it entirely, such as pausing billing or service delivery for a period of time.
Practical examples include:
- Suspending a customer's subscription due to temporary unavailability or request.
- Pausing subscription services during a vacation or leave period.
- Managing subscription lifecycle events programmatically via workflow automation.
Properties
| Name | Meaning |
|---|---|
| Account ID | The unique identifier of the MindzPay account associated with the subscription. |
| Subscription ID | The unique identifier of the subscription that you want to suspend. |
Output
The output of this operation typically contains JSON data representing the updated subscription status after suspension. This may include fields such as subscription ID, current status (e.g., suspended), timestamps, and any relevant metadata returned by the Mindz API.
If the node supports binary data output, it would generally relate to attachments or documents linked to the subscription, but this operation primarily deals with JSON response data indicating the success and details of the suspension action.
Dependencies
- Requires an active connection to the Mindz API using an OAuth2-based API key credential.
- The node depends on the MindzPay Subscription resource module to perform the suspend operation.
- Proper configuration of the Mindz OAuth2 API credentials in n8n is necessary for authentication.
Troubleshooting
Common Issues:
- Invalid or missing Account ID or Subscription ID parameters will cause the operation to fail.
- Authentication errors if the OAuth2 token is expired or invalid.
- Network connectivity issues preventing access to the Mindz API.
Error Messages:
- "Subscription not found" — Verify that the Subscription ID is correct and exists under the specified Account ID.
- "Unauthorized" — Check that the API credentials are valid and have sufficient permissions.
- "Failed to suspend subscription" — Could indicate server-side issues or invalid state transitions; retry or contact support.
Links and References
- Mindz API Documentation (hypothetical link)
- n8n OAuth2 Credential Setup Guide: https://docs.n8n.io/credentials/oauth2/
- General n8n Node Development: https://docs.n8n.io/integrations/creating-nodes/