Ikoula API CS
Overview
This node interacts with the Ikoula CloudStack API to retrieve billing and consumption data related to a user's subscription. Specifically, the "Get Billing Consumption" operation fetches detailed consumption information for a particular billing period within a subscription.
Common scenarios where this node is useful include:
- Automating retrieval of billing consumption data for financial reporting or auditing.
- Integrating Ikoula billing data into dashboards or monitoring tools.
- Triggering workflows based on consumption thresholds or billing events.
For example, a user can configure this node to get the consumption details of a specific billing ID under their subscription, then process or store that data elsewhere automatically.
Properties
| Name | Meaning |
|---|---|
| Subscription ID | The unique numeric identifier of the subscription for which billing data is requested. |
| Billing ID | The unique numeric identifier of the specific billing period to retrieve consumption for. |
| Response Format | The format in which the API response should be returned. Options: JSON, XML. |
Output
The node outputs an array of items, each containing a json field with the API response data:
- If the response format is JSON, the
jsonfield contains the parsed JSON object representing the billing consumption data. - If the response format is XML, the
jsonfield contains the raw XML string under adataproperty.
No binary data output is produced by this node.
Example JSON output structure (simplified):
{
"billingId": 12345,
"subscriptionId": 67890,
"consumptionDetails": {
// detailed consumption metrics here
}
}
Dependencies
- Requires an API key credential for authenticating with the Ikoula CloudStack API.
- The node uses HTTPS requests to the Ikoula API endpoint (default:
https://api.ikoula.com). - The password is encrypted using RSA public key encryption before sending.
- No additional external dependencies beyond standard n8n HTTP request helpers.
Troubleshooting
No credentials provided!
This error occurs if the required API authentication credentials are missing or not configured properly. Ensure you have set up the API key credential in n8n and linked it to this node.HTTP request failures
Network issues, incorrect subscription or billing IDs, or invalid API URLs can cause request errors. Verify all input parameters and network connectivity.Response format issues
If XML is selected but downstream nodes expect JSON, parsing errors may occur. Choose the response format according to your workflow needs.Continue On Fail behavior
If enabled, the node will return error messages as part of the output instead of stopping execution, allowing partial processing of multiple inputs.
Links and References
- Ikoula CloudStack API Documentation (general reference for API endpoints and usage)
- n8n HTTP Request Node Documentation (for understanding HTTP request options)