Opencell icon

Opencell

Consume Opencell API

Overview

The Opencell node for n8n enables integration with the Opencell API, specifically allowing you to manage subscriptions. The "Terminate" Subscription operation is used to end an existing subscription in Opencell, specifying the reason and date for termination, and optionally providing a validity date.

Common scenarios:

  • Automating the cancellation of customer subscriptions when certain business rules are met.
  • Integrating Opencell subscription management into broader workflows (e.g., when a user requests account closure).
  • Ensuring compliance by recording the reason and timing of each subscription termination.

Practical example:
When a customer cancels their service via your website, this node can be triggered to terminate their subscription in Opencell, specifying the appropriate reason and effective date.


Properties

Name Type Meaning
Authentication options Selects the authentication method for connecting to Opencell (Basic Authentication or OAuth2).
Subscription Code string The unique code identifying the subscription to be terminated.
Subscription Validity Date dateTime (Optional) The date until which the subscription remains valid after termination is requested.
Termination Reason options The reason for terminating the subscription (e.g., Agreement Reimbursement Charge, etc.).
Termination Date dateTime The date on which the subscription should be terminated.
Body Content Type hidden Internal property; always set to "multipart-form-data".

Output

  • The output will be a JSON object containing the response from the Opencell API after attempting to terminate the subscription.
  • The structure of the output depends on the Opencell API's response for the termination endpoint, but typically includes status information, messages, and possibly details about the terminated subscription.

Example output:

{
  "actionStatus": "SUCCESS",
  "message": "Subscription terminated successfully.",
  "subscriptionCode": "SUB12345"
}

Note: Actual fields may vary based on Opencell API implementation.


Dependencies

  • External Service: Requires access to an Opencell instance with API enabled.
  • Authentication: You must configure either Basic Authentication or OAuth2 credentials in n8n for the Opencell node.
  • n8n Configuration: Credentials must be set up in n8n under the node’s credential options.

Troubleshooting

Common issues:

  • Invalid Credentials: If authentication fails, ensure that the correct credentials are configured in n8n.
  • Missing Required Fields: If required properties like "Subscription Code", "Termination Reason", or "Termination Date" are missing, the node will throw an error.
  • API Errors: If the subscription code does not exist or the API returns an error, the node will output the error message from Opencell.

Error messages and resolutions:

  • "Username/password error. Error code : XXX": Check your Opencell credentials.
  • "Host error. Error code : XXX": Verify the Opencell API URL and network connectivity.
  • "Invalid credentials (unknown error)": Double-check all credential settings.
  • "Required parameter missing": Ensure all required fields are filled in the node configuration.

Links and References

Discussion