HostBill icon

HostBill

Consume HostBill API (v.0.1.3)

Overview

This node integrates with the HostBill API to add an addon to a specified account. It is useful in scenarios where you need to automate the process of attaching additional services or features (addons) to customer accounts within your HostBill system. For example, you might use this node to automatically provision extra storage, enable premium support, or activate other billable features for a client as part of an onboarding workflow.

Properties

Name Type Meaning
Account ID Number The unique identifier of the account to which the addon will be added.
Addon ID Number The ID of the addon (from the hb_addons table) that should be attached to the account.
Additional Fields Collection Optional settings for the addon addition. Includes:
— Invoice Boolean If set to true, an invoice will be generated for adding this addon.
— Billing cycle Options Specifies the billing cycle for the addon (e.g., Monthly, Annually, etc.).
— Payment Gateway ID Number If generating an invoice, specifies the payment gateway to use for the transaction.

Output

  • The output is a JSON object (or array of objects if multiple items are processed).
  • The structure of the output depends on the response from the HostBill API after attempting to add the addon.
  • If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.
  • No binary data is produced by this operation.

Dependencies

  • External Service: Requires access to a HostBill instance with API enabled.
  • API Credentials: You must configure valid HostBill API credentials in n8n under the name hostBillApi.
  • n8n Configuration: Ensure the HostBill node is properly installed and configured in your n8n environment.

Troubleshooting

  • Common Issues:
    • Invalid or missing API credentials will prevent the node from connecting to HostBill.
    • Incorrect Account ID or Addon ID may result in errors such as "Account not found" or "Addon not found".
    • Insufficient permissions for the API user can cause authorization failures.
  • Error Messages:
    • error: <message>: If "Continue On Fail" is enabled, failed operations will return an object with an error property containing the error message.
    • Credential or connection errors will halt execution unless "Continue On Fail" is set.

Links and References

Discussion