Actions16
Overview
This node interacts with a cloud commerce platform to retrieve subscription data. Specifically, the "Subscription" resource with the "Get Many" operation allows users to fetch multiple subscription records based on various filters and limits.
Common scenarios include:
- Retrieving all active subscriptions for reporting or analytics.
- Filtering subscriptions created within a specific date range.
- Fetching subscriptions by status or associated product, marketplace, or connection IDs.
Practical example:
- A user wants to get all active subscriptions created in the last month to analyze customer retention trends.
- Another use case is fetching up to 100 terminated subscriptions to audit cancellations.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching subscription results or limit the number of returned items. |
| Limit | Maximum number of subscription results to return when "Return All" is false. The maximum allowed value is 500. |
| Filters | Collection of filters to narrow down the subscription results: |
| Status | Filter subscriptions by their status. Options: Pending, Active, Hold, Terminated, Removed. Default is Active. |
| Created After | Filter subscriptions created after a specified date or preset relative date (e.g., Today, Yesterday, 1 Week Ago). |
| Created Before | Filter subscriptions created before a specified date or preset relative date. |
| Product ID | Filter subscriptions by a specific product identifier. |
| Marketplace ID | Filter subscriptions by a specific marketplace identifier. |
| Connection ID | Filter subscriptions by a specific connection identifier. |
Output
The output is an array of JSON objects, each representing a subscription record that matches the query criteria. Each item contains the subscription's details as provided by the cloud commerce platform API.
If the "Return All" option is enabled, all matching subscriptions are returned; otherwise, the number of returned items respects the "Limit" property.
No binary data output is indicated for this operation.
Dependencies
- Requires an initialized API service connection to the cloud commerce platform, authenticated via an API key or token credential configured in n8n.
- The node depends on internal resource registry and utility modules to handle API requests and responses.
Troubleshooting
Common issues:
- Requesting more than the maximum allowed limit (over 500) may cause errors.
- Using invalid filter values (e.g., incorrect status strings or malformed dates) can result in no data or API errors.
- Network or authentication failures will prevent data retrieval.
Error messages:
"Resource Subscription not found or not yet migrated"indicates the resource is unavailable or misconfigured."Unknown error occurred"may appear if the API response is unexpected or there is a runtime exception.
Resolutions:
- Verify the resource and operation names are correct.
- Ensure API credentials are valid and have sufficient permissions.
- Check filter values for correctness and proper formatting.
- Use the "Continue On Fail" option to handle partial failures gracefully.
Links and References
- Refer to the cloud commerce platform's official API documentation for detailed subscription resource schema and filtering options.
- n8n documentation on creating and configuring API credentials.
- n8n community forums for troubleshooting similar integration issues.