HostBill icon

HostBill

Consume HostBill API (v.0.1.3)

Overview

This node allows you to update an existing Account in HostBill via its API. It is designed for scenarios where you need to programmatically modify account details, such as changing the associated product, updating billing information, or altering account status. This is useful in automated workflows for customer management, provisioning, or billing updates.

Example use cases:

  • Automatically update account status to "Suspended" if a payment fails.
  • Change the server or domain associated with an account after migration.
  • Update recurring billing amounts or due dates based on business logic.

Properties

Name Type Meaning
Account ID Number The unique identifier of the account to update. Required.
Additional Fields Collection A set of optional fields to update on the account. See below for available options.

Additional Fields (within "Additional Fields" collection):

Name Type Meaning
Product ID Number Sets the product associated with this account.
Creation Date DateTime Sets the account's creation date.
Domain/Hostname String Sets the domain or hostname for the account.
Server ID Number Specifies the server (by ID) from which this account will be provisioned.
Payment Module ID Number Sets the payment module (by ID) for this account.
First Payment Number Sets the first payment amount for the account.
Recurring Amount Number Sets the recurring billing amount.
Next Due DateTime Sets the next due date for the account.
Status Options Sets the account status. Possible values: Active, Suspended, Terminated.
Username String Sets the username for this account.
Password String Sets the password for this account.
Root Password String Sets the root password for this account.
Notes String Adds notes to the account.

Output

The node returns a JSON object (or array of objects) representing the updated account(s). The exact structure depends on the HostBill API response, but typically includes the updated fields and possibly additional metadata about the account.

If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

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: No special environment variables are required beyond standard credential setup.

Troubleshooting

Common Issues:

  • Invalid Account ID: If the provided Account ID does not exist, the API will return an error.
  • Missing Required Fields: Omitting required fields (like Account ID) will result in validation errors.
  • Permission Denied: If the API credentials lack sufficient permissions, operations will fail.
  • Incorrect Data Types: Providing data in the wrong format (e.g., string instead of number) may cause errors.

Error Handling:

  • If "Continue On Fail" is enabled, errors for individual items will be returned in the output with an error property.
  • Otherwise, the workflow will stop on the first encountered error.

Links and References

Discussion