Mindz icon

Mindz

Interact with Mindz API

Actions115

Overview

The "Subscription Create" operation in this node allows users to create a new subscription entity within the Mindz platform. This operation is useful for automating the setup of recurring billing plans or membership subscriptions, where you define how often and how long a customer will be billed.

Typical use cases include:

  • Creating subscription plans for online courses or digital content.
  • Setting up recurring billing intervals for memberships or services.
  • Automating subscription management workflows by integrating with Mindz API.

For example, you might create a monthly subscription plan named "Premium Access" that bills customers every month indefinitely, or a yearly subscription with a limited number of billing cycles.

Properties

Name Meaning
Name The name of the subscription to create (required).
Description A textual description of the subscription.
Interval The billing interval unit. Options: Days, Weeks, Months, Years.
Frequency The frequency of the billing interval (e.g., every 1 month, every 2 weeks).
Max Cycles Maximum number of billing cycles before subscription ends. 0 means unlimited cycles.
Max Commission Cycles Maximum number of commission cycles applicable to the subscription.

Output

The node outputs JSON data representing the newly created subscription object as returned by the Mindz API. This typically includes details such as subscription ID, name, description, billing interval, frequency, cycle limits, creation timestamps, and status.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2-based API key credential.
  • The node depends on the Mindz platform's subscription API endpoint to create subscriptions.
  • Proper API credentials must be configured in n8n to authenticate requests.

Troubleshooting

  • Missing Required Fields: If the "Name" property is not provided, the API will likely reject the request. Ensure all required fields are filled.
  • Invalid Interval or Frequency: Providing unsupported values for interval or frequency may cause errors. Use only the allowed options for interval and positive integers for frequency.
  • API Authentication Errors: If the OAuth2 credential is invalid or expired, authentication will fail. Refresh or reconfigure the API credentials.
  • Rate Limits or Quotas: Excessive API calls may trigger rate limiting; handle retries or backoff accordingly.
  • Max Cycles Logic: Setting maxCycles to 0 means unlimited cycles; ensure this aligns with your business logic to avoid unintended infinite billing.

Links and References

  • Mindz API Documentation (subscription section) – [Link to official API docs]
  • n8n OAuth2 Credential Setup Guide – [Link to n8n docs on OAuth2 credentials]
  • Recurring Billing Concepts – [General resource on subscription billing models]

Note: The above summary is based solely on static analysis of the provided source code and input properties definition.

Discussion