Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to manage payment plans and related entities. Specifically, the Payment Plan - List operation retrieves a list of payment plans with optional filtering and pagination.

Use cases include:

  • Fetching multiple payment plans for reporting or monitoring.
  • Filtering payment plans by creation date, status, currency, customer ID, or date ranges.
  • Limiting the number of results returned per request to handle large datasets efficiently.

For example, you might use this node to get all open payment plans created within a specific date range or to retrieve the first 20 payment plans in a particular currency.

Properties

Name Meaning
Limit Limits the number of payment plans returned. Value between 1 and 100. Default is 10.
Search Filters Collection of filters to narrow down the list of payment plans:
  Created Date Filter payment plans created on a specific date (date only).
  Currency Filter payment plans by currency code (string).
  Customer ID Filter payment plans by associated customer ID (string).
  Date Range Maximum Upper bound of a date range filter (date only).
  Date Range Minimum Lower bound of a date range filter (date only).
  Status Filter payment plans by status. Options: Canceled, Checkout, Defaulted, Open, Paid, Pending.

Output

The node outputs an array of JSON objects representing payment plans matching the specified criteria. Each object contains detailed information about a payment plan as returned by the Partially API, such as amounts, currency, customer details, status, dates, and metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to the Partially Payment Plans API.
  • Needs an API authentication token configured in n8n credentials for the Partially service.
  • The node uses internal helper functions to make authenticated HTTP requests to the API endpoints.

Troubleshooting

  • Empty results: If no payment plans are returned, verify that your search filters are correct and that there are payment plans matching those criteria.
  • Invalid date formats: Ensure date inputs are valid ISO date strings or compatible with the node's date picker.
  • API authentication errors: Confirm that the API key or token credential is correctly set up and has sufficient permissions.
  • Limit out of range: The "Limit" property must be between 1 and 100; values outside this range may cause errors.
  • Unexpected API errors: Check the node's execution logs for detailed error messages from the API and adjust parameters accordingly.

Links and References

Discussion