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, for the Payment Plan - Get operation, it retrieves detailed information about a specific payment plan by its ID.

Common scenarios where this node is beneficial include:

  • Fetching the current status and details of a customer's payment plan.
  • Integrating payment plan data into workflows for reporting or customer service.
  • Automating follow-up actions based on payment plan attributes.

For example, a business could use this node to automatically retrieve a payment plan's details when a customer inquiry is received, enabling quick access to relevant financial arrangements.

Properties

Name Meaning
Payment Plan ID The unique identifier of the payment plan to retrieve. This is a required string input.

Output

The node outputs a JSON object representing the payment plan details as returned by the Partially API. This typically includes fields such as:

  • id: The payment plan's unique identifier.
  • amount: Total amount of the payment plan.
  • currency: Currency code used in the payment plan.
  • customer_id or customer object: Information about the customer associated with the plan.
  • offer_id or payment_schedule: Terms defining the payment schedule or offer linked to the plan.
  • status: Current status of the payment plan (e.g., open, canceled).
  • meta: Metadata and additional custom fields.
  • Other relevant fields describing line items, payment methods, and contract signatures.

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • Missing or invalid Payment Plan ID: Ensure the "Payment Plan ID" property is provided and correctly formatted. The API will return an error if the ID is missing or does not exist.
  • Authentication errors: Verify that the API key or authentication token is correctly set up in n8n credentials and has sufficient permissions.
  • Network issues: Check connectivity to the Partially API endpoint; timeouts or unreachable errors may occur if network problems exist.
  • API rate limits: If many requests are made in a short period, the API might throttle calls. Implement retry logic or reduce request frequency.
  • Unexpected response structure: If the API changes, the node output format might differ. Review API documentation for updates.

Links and References

Discussion