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 Order resource and the Get All operation, this node retrieves a list of orders from your Billwerk account. It supports advanced filtering by search terms, order status, type, date range, and pagination.

Common scenarios:

  • Fetching all customer orders for reporting or analytics.
  • Filtering orders by status (e.g., only "Completed" or "Failed" orders).
  • Integrating Billwerk order data into other business workflows, such as CRM updates or financial reconciliations.

Practical example:
You could use this node to pull all "Approved" orders created in the last month, then send summary emails or update records in another system.

Properties

Name Type Meaning
Search String Search orders by First Name, Last Name, Company Name, Email Address, Customer ID, or Debtor Account.
Status Options Filter orders by their current status (e.g., Aborted, Approved, Completed, etc.).
Type Options Filter orders by type (e.g., Signup, Upgrade).
Date From DateTime Only include orders created on or after this date/time.
Date To DateTime Only include orders created on or before this date/time.
From String Pagination: ID of the first order to return (for paginated results).
Take Number Pagination: Maximum number of orders to return (up to 500).

Output

The node outputs an array of JSON objects, each representing an order matching the specified filters. The exact structure of each order object depends on the Billwerk API, but typically includes fields such as:

{
  "id": "string",
  "status": "string",
  "type": "string",
  "createdAt": "string (ISO date)",
  "customerId": "string",
  // ...other order-specific fields
}

If an error occurs and "Continue On Fail" is enabled, the output will include an object like:

{
  "error": "Error message"
}

Dependencies

  • External Service: Requires access to the Billwerk API.
  • Credentials: You must configure the billwerkApi credential in n8n.
  • Environment: No special environment variables are required beyond standard n8n setup.

Troubleshooting

Common issues:

  • Invalid credentials: If the billwerkApi credential is missing or incorrect, authentication errors will occur.
  • API limits: Requesting more than 500 items via the "Take" property may result in errors or truncated results.
  • Date format errors: Ensure that "Date From" and "Date To" values are valid ISO date strings.
  • Filter mismatch: Using filters that do not match any orders will return an empty array.

Error messages:

  • "error": "Some error message" — This appears in the output if "Continue On Fail" is enabled and an error occurs for an item. Check the error message for details (e.g., invalid filter, network issue).

Links and References

Discussion