Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to create a new payment plan. It allows users to define payment plans for customers either by referencing an existing customer or by providing new customer details. The node supports specifying the total amount, currency, and detailed payment terms either via an offer ID or a custom payment schedule. This is useful in scenarios where businesses want to offer flexible payment options to their customers, such as installment plans or deferred payments.

Practical examples include:

  • Creating a payment plan for an existing customer based on a predefined offer.
  • Creating a custom payment schedule with flexible down payments and payment frequencies.
  • Adding line items and metadata to the payment plan for detailed tracking.
  • Integrating with third-party platforms like Shopify or WooCommerce by specifying integration details.

Properties

Name Meaning
Amount The total amount of the payment plan.
Currency The currency code for the payment plan (e.g., USD, EUR). Defaults to the currency set in Partially settings or the currency of the provided offer if not specified.
Customer Details Choose whether to use an existing customer ID or provide new customer details. Options: "Use Existing Customer ID", "Provide Customer Details".
Customer ID The ID of an existing customer (required if using existing customer).
Customer Email Email address of the new customer (required if providing new customer details).
Customer First Name First name of the new customer.
Customer Last Name Last name of the new customer.
Additional Customer Fields Additional optional fields for the new customer, including language, phone number, shipping address details, and timezone.
Terms Defines how payment terms are specified. Options: "Provide an Offer ID" or "Provide a Payment Schedule".
Offer ID The ID of the offer to base the payment plan on (used if Terms = "Provide an Offer ID").
Automatically Schedule Installments Whether installments will be scheduled automatically according to the provided schedule (boolean, used if Terms = "Provide a Payment Schedule").
Payment Schedule Description Description of when payments will be processed (used 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 percentage or fixed amount depending on Down Payment Type.
Down Payment Flexible Whether the customer can choose their down payment within a specified range (boolean).
Minimum Down Payment Amount/percentage Minimum allowed down payment if flexible down payment is enabled.
Maximum Down Payment Amount/percentage Maximum allowed down payment if flexible down payment 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 (used if Term Units is not "Date").
Final Payment Date The date of the final payment (used if Term Units = "Date"). Time component is ignored.
Term Flexible Whether the customer can choose their payment frequency within a specified range (boolean).
Minimum Term Minimum term length allowed if term is flexible.
Maximum Term Maximum term length allowed if term is flexible.
Frequency Units Units for payment frequency. Options: "Days", "Weeks", "Months", "Specific Days of the Month".
Frequency Value Number of days, weeks, or months between payments (used if Frequency Units is not "Specific Days of the Month").
Days of the Month Comma-separated list of days of the month to process payments (used if Frequency Units = "Specific Days of the Month").
Frequency Flexible Whether the customer can choose their payment frequency within a specified range (boolean).
Minimum Frequency Minimum frequency allowed if frequency is flexible.
Maximum Frequency Maximum frequency allowed if frequency is flexible.
Automatically Schedule First Installment Whether the first installment will be scheduled relative to the plan opened date (boolean).
Date of First Installment The date of the first installment (used if automatic scheduling of first installment is disabled). Time component is ignored.
Custom Metadata Key-value pairs of custom metadata to add to the payment plan.
Line Items List of line items included in the payment plan. Each item includes name, quantity, price, optional image URL, weight with units, product ID, and variant ID.
Additional Plan Fields Additional optional fields for the payment plan, including:
- Create Stripe Payment Intent (boolean) to enable Stripe payment capture.
- Customer IP Address and User Agent strings.
- Third party integration platform (e.g., Shopify, WooCommerce).
- Plan Status ("Checkout" or "Pending").
- Send Plan Request email option (boolean).
- Shipping address details (address lines, city, country, state, postal code, and shipping name).

Output

The node outputs an array of JSON objects representing the created payment plan(s) returned from the Partially API. The structure includes all details of the payment plan such as:

  • Payment plan ID and status
  • Amount and currency
  • Customer information (existing or newly created)
  • Payment terms (offer ID or detailed payment schedule)
  • Line items and metadata
  • Any additional fields set during creation

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.
  • No other external dependencies are needed.

Troubleshooting

  • Missing Required Fields: Ensure that required fields such as Amount, Customer Details, and either Offer ID or Payment Schedule are provided. Missing these will cause API errors.
  • Invalid Dates: When specifying dates (final payment date, first installment date), ensure they are valid ISO date strings without time components.
  • Flexible Fields Misconfiguration: If enabling flexible down payment, term, or frequency, minimum and maximum values must be logically consistent (min ≤ max).
  • API Authentication Errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Integration Issues: When specifying third-party integrations, ensure the integration name matches supported platforms and that any required IDs are correct.
  • Line Item Validation: Each line item must have a name, quantity, and price; missing these may cause request failures.

Common error messages typically come from the Partially API and relate to validation errors or authentication failures. Reviewing the API response message usually helps identify the issue.

Links and References

Discussion