Opencell icon

Opencell

Consume Opencell API

Actions40

Overview

The Opencell node for n8n enables you to interact with the Opencell API, specifically to manage subscriptions. The Subscription → Create & Instantiate operation allows you to create a new subscription for a user account, select an offer template, define renewal rules, set the subscription date, and instantiate products as part of the subscription. This is useful in scenarios where you need to automate customer onboarding, product provisioning, or recurring billing setups within your business processes.

Practical examples:

  • Automatically subscribe a new user to a service plan when they sign up.
  • Batch-create subscriptions for multiple users based on CRM data.
  • Integrate Opencell subscription management into larger automation workflows (e.g., after payment confirmation).

Properties

Name Type Meaning
Authentication options Selects the authentication method for connecting to Opencell (Basic Authentication or OAuth2).
Code string Unique code for the subscription. Required for creation.
User Account Name or ID options Specifies the user account to subscribe. Can be chosen from a list or entered as an ID/expression.
Activate Subscription boolean If true, activates the subscription immediately after creation.
Offer Template Name or ID options The offer template to use for the subscription. Can be selected from a list or specified by ID/expression.
Renewal Rule collection Defines how the subscription renews, including duration, auto-renewal, end-of-term actions, etc.
Subscription Date dateTime The start date of the subscription. Required.
Product to Instantiate fixedCollection List of products to instantiate as part of the subscription. Each product includes name/ID, quantity, and delivery date.
Body Content Type hidden Internal property; always set to "multipart-form-data".
Custom Fields fixedCollection Allows setting custom fields for the subscription. Supports various field types (string, number, date, boolean, list, etc.), depending on Opencell configuration.

Output

  • The node returns the JSON response from the Opencell API for the subscription creation request.
  • If Activate Subscription is enabled, an additional activation response is returned.
  • The structure of the output json field depends on the Opencell API's response, but typically includes details about the created subscription (such as codes, status, dates, associated products, and any custom fields).
  • No binary data is produced by this operation.

Example output (structure may vary):

{
  "subscription": {
    "code": "SUB123",
    "userAccount": "USER001",
    "offerTemplate": "OFFER_BASIC",
    "status": "ACTIVE",
    "products": [
      {
        "productCode": "PROD1",
        "quantity": 1,
        "deliveryDate": "2024-06-01T00:00:00Z"
      }
    ],
    "renewalRule": {
      "autoRenew": true,
      "endOfTermAction": "SUSPEND"
    },
    "customFields": {
      "fieldName": "value"
    }
  }
}

Dependencies

  • External Service: Requires access to an Opencell instance with API enabled.
  • Authentication: Needs either Basic Auth or OAuth2 credentials configured in n8n.
  • n8n Configuration: Credentials must be set up under the node’s credential options (opencellApi or opencellOAuth2Api).

Troubleshooting

Common issues:

  • Invalid credentials: If authentication fails, ensure that the correct credentials are provided and have sufficient permissions.
  • Missing required fields: Omitting required properties like Code, User Account, Offer Template, or Subscription Date will result in errors.
  • Custom field errors: If custom fields are misconfigured or not supported for the resource, the node may throw an error indicating missing or invalid custom fields.
  • API connectivity: Network issues or incorrect Opencell API URLs can cause connection failures.

Error messages and resolutions:

  • "Username/password error. Error code : ...": Check your Basic Auth credentials.
  • "Host error. Error code : ...": Verify the Opencell API endpoint and network connectivity.
  • "This resource doesn't support custom fields": Ensure you are using custom fields only with supported resources.
  • "There are no custom fields defined for this resource": Check Opencell configuration for available custom fields.

Links and References

Discussion