Ikoula Business API icon

Ikoula Business API

Interact with Ikoula Business API for business operations management. Developed by Ascenzia - www.ascenzia.fr
Join our community

Actions9

Overview

This node integrates with the Ikoula Business API to manage business operations related to subscriptions and services. Specifically, the Terminate Account operation allows users to terminate a subscription account either immediately or at the end of the billing period. This is useful for automating subscription cancellations within workflows, such as when a customer requests service termination or when managing lifecycle events in billing systems.

Practical examples include:

  • Automatically terminating a customer's subscription after a refund.
  • Scheduling service cancellation at the end of the current billing cycle.
  • Integrating termination reasons and descriptions for audit trails or customer support follow-up.

Properties

Name Meaning
Subscription ID The unique identifier of the subscription to be terminated.
Termination Data A collection of termination details including:
- Type: When to terminate the service; options are "End of Period" (termination after current billing period) or "Immediate" (instant cancellation).
- Reason ID: Numeric code representing the reason for termination (retrieved from termination info).
- Description: Optional text description; mandatory if the reason ID is -1 ("Other").
Response Format The format of the API response, either JSON or XML.

Output

The node outputs an array of items where each item contains a json property holding the API response data. The structure depends on the API response format selected (JSON or XML):

  • For JSON responses, the output is parsed into JavaScript objects.
  • For XML responses, the raw XML string is returned inside the data field.

No binary data output is produced by this operation.

Example output snippet (JSON format):

{
  "json": {
    "status": "success",
    "message": "Subscription terminated successfully",
    "subscriptionId": 12345
  }
}

Dependencies

  • Requires valid credentials for the Ikoula Business API, including email, password, and optionally a custom API URL.
  • The password is encrypted using RSA public key encryption before being sent.
  • The node uses HTTP requests to communicate with the Ikoula API endpoints.
  • No additional external dependencies beyond standard n8n credential management and HTTP request helpers.

Troubleshooting

  • No credentials provided!
    Error thrown if the required API credentials are missing. Ensure that the API authentication details are configured correctly in n8n credentials.

  • Invalid Subscription ID or Reason ID
    If the subscription ID or termination reason ID is incorrect or not found, the API may return an error. Verify these IDs against the Ikoula system.

  • Missing Description for 'Other' Reason
    If the reason ID is set to -1 (Other), the description field must be filled. Omitting it may cause the API to reject the request.

  • API Response Errors
    Network issues, invalid parameters, or server errors will result in exceptions. Use the node's "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion