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 various financial entities such as customers, payment plans, offers, payments, refunds, and disputes. Specifically, for the Offer resource with the Get operation, the node retrieves detailed information about a specific offer by its unique identifier.
Common scenarios where this node is beneficial include:
- Fetching details of a particular offer to display or process in workflows.
- Integrating offer data retrieval into automated billing or customer management systems.
- Using offer information to validate or update related payment plans or line items.
Example:
You have an offer ID from a previous step or external system, and you want to retrieve all details about that offer to decide on further processing or notifications.
Properties
| Name | Meaning |
|---|---|
| Offer ID | The unique identifier of the offer to retrieve. This is a required string input. |
Output
The output is a JSON array containing the retrieved offer object(s). Each item in the array corresponds to one offer's data as returned by the Partially API. The structure typically includes all fields describing the offer, such as its ID, terms, associated customer or payment plan references, amounts, metadata, and other relevant attributes defined by the API.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Partially Payment Plans API.
- Needs an API authentication token or key configured in n8n credentials to authorize requests.
- The node uses internal helper functions to make HTTP requests to the API endpoints.
Troubleshooting
Common issues:
- Invalid or missing Offer ID will cause the API request to fail.
- Network connectivity problems can prevent successful API calls.
- Insufficient permissions or invalid API credentials will result in authorization errors.
Error messages:
- "Offer not found" — The provided Offer ID does not exist; verify the ID.
- "Unauthorized" or "Authentication failed" — Check that the API key credential is correctly set up.
- "Request timeout" or "Network error" — Ensure network access to the API endpoint.
Resolving these usually involves verifying input parameters, checking API credentials, and ensuring stable network connectivity.
Links and References
- Partially Payment Plans API Documentation (replace with actual URL if available)
- n8n documentation on Creating Custom Nodes