Mindz icon

Mindz

Interact with Mindz API
Join our community

Actions115

Overview

The node provides an interface to update subscription plans within the Mindz platform via its API. It allows users to modify various attributes of a subscription plan, such as its name, description, pricing, billing intervals, media assets, and access controls. This node is beneficial in scenarios where subscription details need to be programmatically maintained or synchronized with external systems, for example:

  • Updating subscription pricing or descriptions based on marketing campaigns.
  • Changing access durations or client limits dynamically.
  • Managing subscription media content like banners and videos.
  • Adjusting billing cycles and commission settings.

Practical examples include automating subscription updates after a product rebranding or adjusting billing frequency for special promotions.

Properties

Name Meaning
Subscription Plan ID The unique identifier of the subscription plan to update (required).
Description A detailed description of the subscription plan.
Name The name/title of the subscription plan.
Short Description A brief summary or tagline for the subscription.
Syllabus Content outline or syllabus associated with the subscription.
Video URL or reference to a video related to the subscription.
Video ID Identifier for the video asset linked to the subscription.
Launch Date The date when the subscription plan becomes available.
Image URL or path to an image representing the subscription.
Redirect URL to redirect users after certain actions related to the subscription.
Price The cost of the subscription plan.
Password Password protection for the subscription (input masked).
Slug URL-friendly identifier for the subscription.
Access Days Number of days users have access after purchase.
FAQ Active Boolean flag indicating if FAQs are active for this subscription.
FAQ Base Questions Boolean flag indicating if base FAQ questions are included.
Client Limit Count Maximum number of clients allowed for this subscription.
Client Limit With Bank Slip Boolean flag to allow client limit when payment is made via bank slip.
Members Description Description targeted at members of the subscription.
Original Banner URL or path to the original banner image.
Main Banner URL or path to the main banner image.
Small Banner URL or path to a smaller banner image variant.
Vertical Card URL or path to vertical card image representation.
Horizontal Card URL or path to horizontal card image representation.
Show Gradient Boolean flag to show gradient overlay on images or UI elements.
Interval Billing interval unit; options: Days, Weeks, Months, Years.
Frequency Billing frequency count (e.g., every 1 month, every 2 weeks).
Max Cycles Maximum number of billing cycles (0 means unlimited).
Max Commission Cycles Maximum number of commission cycles applicable.

Output

The node outputs JSON data representing the updated subscription plan details as returned by the Mindz API. This typically includes all the updated fields reflecting the current state of the subscription after modification.

If the node supports binary data output (not indicated here), it would represent media assets or files related to the subscription, but this is not explicitly shown in the provided code or properties.

Dependencies

  • Requires an API key credential for authenticating with the Mindz API.
  • The node depends on the Mindz OAuth2 authentication configured in n8n.
  • Network connectivity to the Mindz API endpoint is necessary.
  • No additional external libraries or services are indicated beyond the bundled resource modules.

Troubleshooting

  • Missing Required Fields: Ensure the "Subscription Plan ID" is provided; otherwise, the update cannot proceed.
  • Authentication Errors: Verify that the API key or OAuth2 credentials are correctly set up and valid.
  • Invalid Field Values: Some fields like "Price", "Access Days", or "Frequency" expect specific formats or numeric values; invalid inputs may cause errors.
  • API Rate Limits: Frequent updates might hit API rate limits; consider adding delays or batching requests.
  • Network Issues: Connectivity problems can cause timeouts or failures; check network status and proxy settings if applicable.

Common error messages might include:

  • Unauthorized or authentication failed — check credentials.
  • Resource not found — verify the subscription ID exists.
  • Validation errors — review input property values for correctness.

Links and References

Discussion