Skip to main content
Version: 1.0.0

Subscriptions

The Customer Subscriptions for Craft CMS allows site administrators to enable and configure a subscription feature for customers. This documentation explains the available configurations and their purposes.

Features Overview

  • Add subscription functionality to the frontend.
  • Allow guests to subscribe without logging in.
  • Require email confirmation for subscriptions.
  • Manage default system-defined subscriptions.
  • Add, modify, and reorder custom subscriptions.

Configuration Options

Subscriptions

This section controls the main subscription functionality.

Enabled

  • Description: Activates the subscription feature on the frontend.
  • Default: Disabled
  • Instructions: If enabled, a subscription form will be available on the frontend.

Allow Guest Subscription

  • Description: Allows non-logged-in users to subscribe.
  • Default: Disabled
  • Instructions: Toggle this option to enable guest subscriptions.

Need to Confirm

  • Description: Requires subscribers to confirm their subscription via email.
  • Default: Disabled
  • Instructions: Enable this to add an email confirmation step.

Default Customer Subscriptions

  • Description: Predefined system subscriptions that cannot be deleted or modified.
  • Usage: View and reference the available system-defined subscriptions.

Example Table:

SubscriptionKey
Weekly UpdatesWK_UP
Monthly OffersMN_OFF

Notes

  • System-defined subscriptions are immutable but provide a solid foundation.
  • Custom subscriptions offer flexibility to adapt to unique business requirements.