Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to create a new payment schedule associated with an existing payment plan. It allows users to define detailed installment plans, including amounts, down payments, terms, frequencies, and scheduling options. This is useful for businesses that want to automate and customize how customers pay over time, such as subscription services, financing offers, or installment-based sales.

Typical use cases include:

  • Creating a payment schedule for a customer's payment plan with automatic installment scheduling.
  • Defining flexible down payment options and term lengths.
  • Specifying payment frequency by days, weeks, months, or specific days of the month.
  • Allowing customers some flexibility in choosing their payment terms within defined ranges.
  • Scheduling the first installment automatically or on a specified date.

Properties

Name Meaning
Payment Plan ID The identifier of the payment plan to which this payment schedule will be attached.
Amount The total amount for the payment schedule.
Automatically Schedule Installments Whether installments should be scheduled automatically according to the provided schedule parameters (true or false).
Payment Schedule Description A textual description of when payments will be processed; used only if automatic scheduling is disabled.
Down Payment Type Specifies if the down payment is a fixed amount or a percentage of the plan amount. Options: "Percentage of Plan Amount", "Fixed Amount".
Down Payment Amount/percentage The value of the down payment, either as a fixed amount or percentage depending on the type selected.
Down Payment Flexible Whether the customer can choose their down payment within a specified range (true or false).
Minimum Down Payment Amount/percentage The minimum allowed down payment if flexibility is enabled.
Maximum Down Payment Amount/percentage The maximum allowed down payment if flexibility is enabled.
Term Units The units for the term length. Options: "Date", "Fixed Number of Payments", "Months", "Weeks", "Years".
Term Value The number of weeks, months, years, or payments for the term (ignored if Term Units is "Date").
Final Payment Date The date of the final payment; used only if Term Units is set to "Date". Time component is ignored.
Term Flexible Whether the customer can choose their payment term within a specified range (true or false).
Minimum Term The minimum term length allowed if flexibility is enabled.
Maximum Term The maximum term length allowed if flexibility is enabled.
Frequency Units The units for payment frequency. Options: "Days", "Weeks", "Months", "Specific Days of the Month".
Frequency Value The number of days, weeks, or months between payments (ignored if Frequency Units is "Specific Days of the Month").
Days of the Month Comma-separated list of days of the month on which payments are processed; used only if Frequency Units is "Specific Days of the Month".
Frequency Flexible Whether the customer can choose their payment frequency within a specified range (true or false).
Minimum Frequency The minimum frequency allowed if flexibility is enabled.
Maximum Frequency The maximum frequency allowed if flexibility is enabled.
Automatically Schedule First Installment Whether the first installment will be scheduled relative to the plan opened date (true or false).
Date of First Installment The date of the first installment; used only if automatic scheduling of the first installment is disabled. Time component is ignored.

Output

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

  • The payment schedule ID.
  • Associated payment plan ID.
  • Amount and currency.
  • Down payment details.
  • Term and frequency settings.
  • Schedule of installments.
  • Metadata and descriptions.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the Partially Payment Plans API.
  • Requires an API key credential configured in n8n for authentication with the Partially API.
  • Uses internal helper functions to make HTTP requests to the API endpoints.

Troubleshooting

  • Missing or invalid Payment Plan ID: Ensure the Payment Plan ID provided exists and is correctly formatted.
  • Invalid date formats: Dates must be valid ISO date strings; times are ignored but dates must be parseable.
  • Conflicting scheduling options: If automatic scheduling is disabled, ensure a description is provided; if enabled, all required scheduling fields must be properly set.
  • API authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
  • Flexible ranges misconfiguration: When enabling flexibility for down payment, term, or frequency, ensure minimum values are less than or equal to maximum values.
  • Frequency days format: When using specific days of the month, provide a comma-separated string of valid day numbers (e.g., "1,15").

If the node throws errors related to request failures, check network connectivity and API status.

Links and References

Discussion