Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions116

Overview

The MindzPay Subscription List operation allows users to retrieve a paginated list of subscriptions associated with a specific MindzPay account. This node is useful for scenarios where you need to manage or analyze subscription data, such as generating reports on active subscriptions, monitoring customer activity, or integrating subscription information into other workflows.

Practical examples include:

  • Fetching all subscriptions for an account to display in a dashboard.
  • Filtering subscriptions by search terms to find specific customers.
  • Sorting subscriptions by creation date or status to prioritize follow-ups.

Properties

Name Meaning
Account ID The unique identifier of the MindzPay account whose subscriptions you want to list.
Limit Maximum number of subscription records to return (minimum 1).
Offset Number of subscription records to skip before starting to collect the result set.
Sort By Field to sort the subscription results by. Options: ID, Created At, Customer Email, Active
Sort Direction Direction to sort the results: Ascending or Descending
Search A search term to filter the subscription results based on matching criteria

Output

The output contains a JSON array of subscription objects corresponding to the requested MindzPay account. Each object typically includes details such as subscription ID, creation date, customer email, and active status. The exact structure depends on the MindzPay API response but generally provides comprehensive subscription metadata.

If the node supports binary data output (not indicated here), it would represent attachments or files related to subscriptions; however, this operation primarily returns JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Mindz API.
  • The node depends on the Mindz OAuth2 authentication setup within n8n.
  • Network access to the Mindz API endpoints is necessary.

Troubleshooting

  • Missing or invalid Account ID: Ensure the Account ID parameter is provided and correctly formatted; otherwise, the API call will fail.
  • API authentication errors: Verify that the API key or OAuth2 credentials are valid and have sufficient permissions.
  • Pagination issues: If the limit or offset parameters are set incorrectly, you might receive incomplete or empty results.
  • Sorting or filtering not working: Confirm that the sortBy and search parameters use supported values and formats.
  • Network or API downtime: Check connectivity and Mindz service status if requests time out or fail unexpectedly.

Links and References

Discussion