Skip to main content

Enrollment Plugins

Enrollment plugins handle subscription-based products and recurring orders.

Adapter KeyDescriptionPreset
shop.unchained.enrollments.licensedLicensed subscription with period-based accessbase

How Enrollments Work​

  1. Customer purchases a subscription product (PLAN_PRODUCT)
  2. An enrollment is created linking the customer to the product
  3. The enrollment adapter determines billing periods
  4. Orders are automatically generated for each period
  5. Access is granted based on active periods

Key Concepts​

Enrollment Status​

StatusDescription
INITIALEnrollment created but not yet active
ACTIVESubscription is active
PAUSEDPaused because of overdue payments
TERMINATEDPermanently ended

Periods​

Each enrollment tracks periods which represent billing cycles: start, end, isTrial, and the orderId of the order generated for the period.

Creating Custom Enrollment Plugins​

See Custom Enrollment Plugins for creating your own enrollment adapters.