AsaasInstall

Overview

This node integrates with the Asaas API to manage recurring subscriptions ("Assinatura" resource) among other payment-related resources. Specifically, the Get Many operation for the subscription resource retrieves multiple subscription records from Asaas, optionally filtered by customer ID and status, and limited in number.

Common scenarios where this node is beneficial include:

• Fetching a list of active or canceled subscriptions for reporting or synchronization.
• Retrieving subscriptions for a specific customer to analyze their recurring payments.
• Integrating subscription data into workflows that automate billing, notifications, or analytics.

Practical example:

• A business wants to pull all active subscriptions for a particular customer to send renewal reminders.
• An accounting workflow fetches all subscriptions (up to a specified limit) to reconcile recurring revenue.

Properties

Output

The output is an array of JSON objects representing subscription records retrieved from the Asaas API. Each item corresponds to one subscription and contains all fields returned by the API for that subscription.

Example structure of each JSON object (fields depend on Asaas API response):

{
  "id": "sub_000001234567",
  "customer": "cus_000005219613",
  "billingType": "CREDIT_CARD",
  "value": 100.00,
  "nextDueDate": "2024-07-01",
  "cycle": "MONTHLY",
  "status": "ACTIVE",
  "description": "Monthly subscription",
  "externalReference": "ref123",
  "endDate": null,
  "maxPayments": 0,
  ...
}

No binary data is output by this operation.

Dependencies

• Requires an API key credential for authenticating with the Asaas API.
• The node uses the Asaas REST API v3 endpoints.
• Supports both sandbox and production environments based on credential configuration.
• No additional external dependencies beyond standard HTTP requests.

Troubleshooting

• Package Removed Error: If the node throws an error indicating the package was removed from npm, it means the underlying integration package is no longer available. The user should remove this node from their workflow.
• Invalid Customer ID: When filtering by customer, ensure the customer ID is valid and exists in Asaas; otherwise, the API may return errors or empty results.
• Limit Value: Setting the limit below 1 will cause validation errors; use 1 or higher.
• API Authentication Errors: Ensure the API key credential is correctly configured and has access to the required environment (sandbox or production).
• Network Issues: Timeouts or connectivity problems can cause request failures; verify network access to Asaas API endpoints.

Links and References

• Asaas API Documentation
• Asaas Subscription API Reference
• n8n Documentation - Creating Custom Nodes