Asaas icon

Asaas

Integração com a API do Asaas para pagamentos e cobranças
Join our community

Actions29

Overview

This node integrates with the Asaas API to manage recurring subscriptions, including creating, retrieving, updating, and canceling subscriptions. Specifically, the Cancelar (Cancel) operation under the Assinatura (Subscription) resource allows users to cancel an existing subscription by its unique ID.

Common scenarios for this node include automating subscription lifecycle management in payment workflows, such as stopping recurring billing when a customer cancels their service or subscription plan. For example, if a user wants to automatically cancel a customer's subscription upon receiving a cancellation request, this node can be used to call the Asaas API and perform that action seamlessly within an n8n workflow.

Properties

Name Meaning
ID Da Assinatura * The unique identifier of the subscription to be canceled. This is a required string input.

Output

The output of the Cancelar operation is the JSON response returned by the Asaas API after deleting the subscription. Typically, this will confirm the cancellation or provide details about the deleted subscription. The output is structured as:

{
  "json": {
    // Response data from the DELETE /subscriptions/{subscriptionId} endpoint
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Asaas API.
  • The node uses the Asaas API base URL, which switches between sandbox and production environments based on the credential configuration.
  • No additional external services are required beyond the Asaas API.

Troubleshooting

  • Package Availability: The node checks if the npm package is available; if not, it throws an error instructing to remove the node from the installation.
  • Invalid Subscription ID: If the provided subscription ID is missing or invalid, the API call will fail. Ensure the ID is correct and corresponds to an existing subscription.
  • API Authentication Errors: If the API key is incorrect or missing, requests will fail with authentication errors. Verify the API key credential is properly configured.
  • Network Issues: Timeouts or connectivity problems may cause request failures. Check network access to the Asaas API endpoints.
  • Error Handling: If continueOnFail is enabled, errors during execution will be captured in the output JSON under an error field instead of stopping the workflow.

Links and References

Discussion