Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

The node integrates with the Partially Payment Plans API to manage offers, specifically allowing updating of existing offers. It enables users to modify various aspects of an offer such as its name, currency, payment schedule, down payment details, term and frequency settings, and installment scheduling options.

This node is beneficial in scenarios where businesses need to programmatically update payment offer details for customers, such as adjusting payment terms or schedules based on customer negotiations or changes in business policies.

For example, a merchant can use this node to update an offer's payment schedule to allow flexible down payments or change the frequency of installments without manually editing the offer in the Partially platform.

Properties

Name Meaning
Name The name of the offer.
Currency Default currency used for payment plans if not specified (e.g., USD).
Automatically Schedule Installments Whether installments should be automatically scheduled according to the provided schedule (true/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 percentage of the plan amount or a fixed 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.
Down Payment Flexible Allows the customer to choose their down payment within a specified range (true/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 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 Allows the customer to choose their payment term within a specified range (true/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 Units for the frequency of payments. 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 to process payments; used only if Frequency Units is "Specific Days of the Month".
Frequency Flexible Allows the customer to choose their payment frequency within a specified range (true/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 to automatically schedule the first installment relative to the plan opened date (true/false).
Date of First Installment The specific date of the first installment; used only if automatic scheduling of the first installment is disabled. Time component is ignored.
Offer ID The unique identifier of the offer to update. This is required to specify which offer is being modified.

Output

The node outputs a JSON array containing the updated offer object returned from the Partially API after the update operation. This object includes all current properties of the offer reflecting the changes made.

No binary data output is involved.

Dependencies

  • Requires connection to the Partially Payment Plans API.
  • Requires an API key credential configured in n8n for authentication with the Partially API.
  • The node uses internal helper functions to prepare the offer data payload before sending the update request.

Troubleshooting

  • Missing or invalid Offer ID: The update operation requires a valid offer ID. Ensure the Offer ID property is correctly set and corresponds to an existing offer.
  • API Authentication Errors: If the API key credential is missing or invalid, requests will fail. Verify that the API key is properly configured in n8n credentials.
  • Invalid Property Values: Providing inconsistent or invalid values for properties like term units, frequency units, or down payment ranges may cause API errors. Double-check that values conform to expected types and constraints.
  • Date Formatting Issues: Dates are converted to ISO strings without time components. Ensure input dates are valid and properly formatted.
  • Network or API Downtime: Connectivity issues or Partially API downtime will prevent successful updates. Check network connectivity and API status.

Links and References

Discussion