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
This node integrates with the Partially Payment Plans API to manage payment plans and related resources. Specifically, for the Payment Plan - Cancel operation, it allows users to cancel an existing payment plan. This can be useful in scenarios where a customer decides to terminate their payment agreement or when a merchant needs to halt a payment plan due to changes in order status or customer requests.
A practical example: A merchant using Shopify might want to cancel a customer's payment plan if the associated order is canceled or refunded. The node supports options to also cancel the linked Shopify order and optionally restock the inventory, streamlining the workflow between Partially and Shopify.
Properties
| Name | Meaning |
|---|---|
| Payment Plan ID | The unique identifier of the payment plan to be canceled. |
| Cancel Associated Shopify Order | Boolean option to also cancel the Shopify order linked to this payment plan. |
| Restock Associated Shopify Inventory | Boolean option to restock the inventory of the canceled Shopify order (only applicable if the previous option is true). |
Output
The node outputs a JSON object representing the updated state of the canceled payment plan as returned by the Partially API. This typically includes details such as the payment plan's ID, status (which would reflect cancellation), timestamps, and any related metadata.
No binary data output is involved in this operation.
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.
- If using the Shopify-related cancellation options, the integration assumes that the Partially API has access or linkage to the relevant Shopify store/order data.
Troubleshooting
- Invalid Payment Plan ID: If the provided Payment Plan ID does not exist or is malformed, the API will return an error. Verify the ID before running the node.
- Authorization Errors: Missing or incorrect API credentials will cause authentication failures. Ensure the API key/token is correctly set up in n8n credentials.
- Shopify Cancellation Failures: If "Cancel Associated Shopify Order" is enabled but the Shopify order cannot be found or canceled, the operation may partially fail or return errors. Confirm the linkage between Partially and Shopify is properly configured.
- Restock Option Without Shopify Cancellation: Enabling "Restock Associated Shopify Inventory" without enabling "Cancel Associated Shopify Order" has no effect; ensure the first option is enabled if restocking is desired.
Links and References
- Partially API Documentation (general reference for API endpoints and usage)
- Shopify Order Management (for understanding order cancellation and inventory restocking concepts)