Actions37
- Offer Item Actions
- Customer Actions
- Dispute Actions
- Installment Actions
- Line Item Actions
- Offer Actions
- Payment Actions
- Payment Method Actions
- Payment Plan Actions
- Payment Schedule Actions
- Refund Actions
Overview
The node integrates with the Partially Payment Plans API to manage "Offer Item" resources, specifically supporting the update operation. It allows users to modify existing offer items by changing their name, amount type (fixed or percentage), and amount value. This is useful in scenarios where payment plans include customizable offer items that may need adjustments after creation, such as updating discounts or fees applied to a payment plan.
Practical examples:
- Updating an offer item to change its discount from a fixed amount to a percentage.
- Modifying the amount of an offer item to increase or decrease the subtotal adjustment on a payment plan.
Properties
| Name | Meaning |
|---|---|
| Name | The name of the offer item. |
| Amount Type | The type of amount applied: either "Fixed" (a set amount) or "Percentage" (calculated based on the payment plan subtotal). |
| Amount | The numeric value of the amount. Using a negative number reduces the subtotal of the payment plan. |
| Offer Item ID | The unique identifier of the offer item to update. |
Output
The node outputs an array of JSON objects representing the updated offer item(s) returned from the Partially API after the update operation. Each object contains details about the offer item, including its updated properties such as name, amount type, amount, and identifiers.
No binary data output is involved.
Dependencies
- Requires connection to the Partially Payment Plans API.
- Needs an API authentication token configured in n8n credentials for the Partially API.
- The node uses internal helper functions to make HTTP requests to the API endpoints.
Troubleshooting
Common issues:
- Invalid or missing offer item ID will cause the update request to fail.
- Providing an invalid amount type or amount format may result in API errors.
- Network or authentication failures can prevent successful API calls.
Error messages:
- Errors related to "offer_item_id" not found indicate the specified offer item does not exist; verify the ID.
- Authentication errors suggest misconfigured or expired API credentials.
- Validation errors from the API may occur if required fields are missing or have invalid values; ensure all required properties are correctly set.
Links and References
- Partially Payment Plans API Documentation (example placeholder, replace with actual URL if available)