Lectful Central icon

Lectful Central

Interact with the Lectful Central API for admin operations

Actions63

Overview

The "Get Plan" operation in the Subscription Management resource of the Lectful Central node retrieves detailed information about a specific subscription plan by its unique plan ID. This node interacts with the Lectful Central API, allowing administrators or automation workflows to fetch plan details such as name, description, status, and associated product family.

Common scenarios where this node is beneficial:

  • Automating subscription management workflows that require fetching plan details for validation or display.
  • Integrating subscription plan data into CRM, billing, or reporting systems.
  • Synchronizing plan information between Lectful Central and other platforms.

Practical example:
An e-commerce platform uses this node to retrieve subscription plan details when a customer selects a plan during checkout, ensuring accurate pricing and feature information is displayed.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful Central API:
- Use Stored Credentials
- Manual Configuration (provide base URL and API key manually)
Credentials Note Informational note shown only when using Manual Configuration mode, explaining credential usage.
Base URL Override Optional base URL to override the stored credential's base URL (excluding /api/v1).
API Key Override Optional API key to override the stored credential's API key.
Plan ID The unique numeric identifier of the subscription plan to retrieve. This is required.

Output

The output is a JSON object representing the subscription plan details returned from the Lectful Central API. It typically includes fields such as:

  • id: The plan's unique identifier.
  • name: The name of the subscription plan.
  • description: A textual description of the plan.
  • product_family_id: Identifier linking the plan to a product family.
  • is_active: Boolean indicating if the plan is currently active.
  • sort_order: Numeric value used for ordering plans in lists.

If the API returns the response as a string, the node attempts to parse it into JSON before outputting.

No binary data is produced by this operation.

Dependencies

  • Requires access to the Lectful Central API.
  • Authentication can be provided either via:
    • Stored credentials configured in n8n (an API key and base URL).
    • Manual configuration by specifying the base URL and API key directly in the node parameters.
  • The node sends HTTP requests with Bearer token authorization and expects JSON responses.
  • No additional external dependencies are required.

Troubleshooting

  • Missing or invalid credentials:
    If neither stored credentials nor manual overrides are properly set, the node will throw an error indicating missing or invalid credentials. Ensure that either valid stored credentials are configured or manual base URL and API key are provided.

  • Base URL Override required in Manual mode:
    When using Manual Configuration mode, the Base URL Override must be specified; otherwise, an error is thrown.

  • API Key Override required in Manual mode:
    Similarly, the API Key Override must be provided in Manual mode.

  • Invalid Plan ID:
    Providing an invalid or non-existent Plan ID may result in an API error or empty response. Verify the Plan ID is correct.

  • Network or API errors:
    Network issues or API downtime will cause request failures. Check connectivity and API status.

  • JSON parsing errors:
    If the API returns malformed JSON, the node logs a warning and outputs the raw string.

Links and References

Discussion