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 Contract resource and the Get operation, this node retrieves detailed information about a specific contract in your Billwerk account based on its unique identifier.

Common scenarios:

  • Fetching contract details to display or process in subsequent workflow steps.
  • Validating contract status before performing billing or customer service actions.
  • Integrating contract data into reporting or analytics workflows.

Practical example:
You might use this node to look up a customer's contract by ID after receiving a webhook from your CRM, then use the returned data to trigger notifications or update records in other systems.

Properties

Name Type Meaning
Contract ID String The unique identifier of the contract you want to retrieve from Billwerk.

Output

The output is a JSON object containing the details of the requested contract. The exact structure depends on the Billwerk API but typically includes fields such as contract ID, customer information, status, start/end dates, and plan details.

Example output (structure may vary):

{
  "id": "contract_12345",
  "customerId": "customer_67890",
  "status": "active",
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": null,
  "plan": {
    "name": "Pro Plan",
    "price": 49.99
  },
  ...
}

Note: This node does not output binary data.

Dependencies

  • External Service: Requires access to the Billwerk API.
  • Credentials: You must configure the billwerkApi credential in n8n for authentication.

Troubleshooting

Common issues:

  • Invalid Contract ID: If the provided Contract ID does not exist, the node will return an error message indicating that the contract was not found.
  • Authentication errors: If the billwerkApi credentials are missing or incorrect, you may receive authentication/authorization errors.
  • API rate limits: Excessive requests may result in rate limiting by Billwerk.

Error handling:

  • If "Continue On Fail" is enabled, errors for individual items will be included in the output as { "error": "Error message" }.
  • Otherwise, the workflow will stop on the first encountered error.

Links and References

Discussion