Billwerk icon

Billwerk

Automate your subscription business with billwerk

Actions27

Overview

The Billwerk node for n8n automates interactions with the Billwerk subscription management platform. Specifically, when using the Payment resource and the Get All operation, this node retrieves a list of payment records from your Billwerk account. This is useful for scenarios such as:

  • Synchronizing payment data with other systems (e.g., accounting or CRM).
  • Generating reports on payment statuses.
  • Filtering payments by date, status, or search terms for further processing.

Practical examples:

  • Fetch all successful payments in the last month to update financial dashboards.
  • Retrieve failed payments to trigger customer notifications or retry logic.
  • Search for payments related to a specific customer or contract.

Properties

Name Type Meaning
From String Pagination: ID of the first payment to return. Useful for paginating through large result sets.
Take Number Pagination: Maximum number of payments to return (up to 500). Controls batch size for each request.
Search String Search term to filter payments by Transaction ID, Provider Transaction ID, Customer Name, or Contract ID.
Status Options Filter payments by their current status (e.g., Succeeded, Failed, Pending, etc.).
Date From DateTime Only include payments created on or after this timestamp.
Date To DateTime Only include payments created on or before this timestamp.

Output

The output is an array of JSON objects, each representing a payment record retrieved from Billwerk. The exact structure of each payment object depends on the Billwerk API, but typically includes fields such as:

{
  "id": "string",
  "amount": "number",
  "currency": "string",
  "status": "string",
  "createdAt": "string (ISO date)",
  "customerId": "string",
  // ...other payment-related fields
}
  • If an error occurs and "Continue On Fail" is enabled, the output may include objects with an error field containing the error message.

Dependencies

  • External Service: Requires access to the Billwerk API.
  • Credentials: You must configure the billwerkApi credential in n8n with valid API keys or authentication details for your Billwerk account.

Troubleshooting

Common Issues:

  • Invalid Credentials: If the API key or credentials are incorrect, the node will throw an authentication error. Ensure your billwerkApi credentials are up-to-date.
  • API Rate Limits: Excessive requests may be throttled by Billwerk. Consider adjusting pagination (Take) or adding delays between executions.
  • Incorrect Filters: Using invalid values for filters (e.g., unsupported status) may result in empty results or errors.
  • Date Format Errors: Ensure that "Date From" and "Date To" are provided in a valid ISO date format.

Error Handling:

  • If "Continue On Fail" is enabled, errors for individual items will appear in the output as { "error": "Error message" }.
  • Otherwise, execution stops at the first error encountered.

Links and References

Discussion