Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to manage various resources related to payment plans, customers, offers, payments, and more. Specifically, for the Line Item - Create operation, it allows users to add a new line item to an existing payment plan. This is useful in scenarios where you want to itemize charges or products within a payment plan, such as adding product details, quantities, prices, and metadata.

Practical examples include:

  • Adding a product line item to a customer's payment plan with quantity and price.
  • Including additional information like weight, image URL, or integration identifiers for third-party services (e.g., Shopify).
  • Attaching custom metadata to line items for enhanced tracking or integration purposes.

Properties

Name Meaning
Payment Plan ID The identifier of the payment plan to which the line item will be added.
Description A textual description of the line item (e.g., product name or service description).
Quantity The number of units for this line item.
Amount The unit price of the line item; can be positive or negative to represent charges or discounts.
Image URL Optional URL linking to an image representing the line item (e.g., product photo).
Weight Optional numeric value representing the weight of the line item.
Weight Unit Unit of measurement for the weight; options are: G (grams), Kg (kilograms), Oz (ounces), Lb (pounds).
Integration Optional name of a third-party service to send the line item to (e.g., "shopify", "bigcommerce").
Integration ID Optional identifier of the line item in the specified third-party service.
Custom Metadata Optional key-value pairs to attach custom metadata to the line item for additional context.

Output

The node outputs an array of JSON objects representing the created line items as returned by the Partially API. Each object contains the details of the newly created line item, including all properties sent and any additional data assigned by the API.

If binary data were involved, it would typically represent files or images associated with the line item, but in this case, the node only handles JSON data.

Dependencies

  • Requires an active connection to the Partially Payment Plans API.
  • Needs an API authentication token or API key credential configured in n8n to authorize requests.
  • No other external dependencies are required.

Troubleshooting

  • Missing Required Fields: Ensure that Payment Plan ID, Description, Quantity, and Amount are provided, as they are mandatory.
  • Invalid Weight Unit: If specifying weight, confirm that the weight unit is one of the allowed options (g, kg, oz, lb).
  • API Authentication Errors: Verify that the API key or token credential is correctly set up and has sufficient permissions.
  • Network Issues: Check connectivity to the Partially API endpoint.
  • Metadata Format: When adding custom metadata, ensure keys and values are strings and properly formatted.

Common error messages might include:

  • Unauthorized access due to invalid credentials.
  • Validation errors if required fields are missing or incorrectly formatted.
  • Resource not found if the specified payment plan ID does not exist.

Resolving these usually involves verifying input parameters and credential configurations.

Links and References

Discussion