Overview

This node operation cancels a subscription in the Payfunnels system. It supports different cancellation options such as immediate cancellation, cancellation at the end of the subscription period, or cancellation on a custom date. This is useful for automating subscription management workflows, for example, when a customer requests to stop their subscription immediately or at a specific future date.

Use Case Examples

1. Cancel a subscription immediately upon customer request.
2. Schedule a subscription to cancel at the end of the current billing period.
3. Set a custom cancellation date for a subscription based on customer preference.

Properties

Name	Meaning
Subscription ID	The unique identifier of the subscription to be canceled.
Cancellation Option	Specifies how the subscription should be canceled: immediately, at the end of the period, or on a custom date.
Cancel Date	The specific date to cancel the subscription if the 'Custom Date' cancellation option is selected.

Output

JSON

• id - The ID of the canceled subscription.
• cancellationOption - The cancellation option applied to the subscription.
• cancelDate - The cancellation date if a custom date was specified.
• status - The status of the subscription after cancellation.

Dependencies

• Requires Payfunnels API credentials including an authorization ID and API key.

Troubleshooting

• Common issues include invalid subscription ID or unauthorized API credentials, which result in error messages from the Payfunnels API.
• If the 'Custom Date' option is selected but no valid date is provided, the request will fail.
• Ensure the API credentials are correctly configured and have the necessary permissions to cancel subscriptions.