Skip to main content

Subscription States

Subscription State Diagram

A user subscription has the following states:

  • created - the initial state when a new subscription is created
  • pending - this state indicates that the subscription is now awaiting a payment & has a pending mandate attached to the subscription
  • active - this state indicates that the subscription has been paid for the current period & is considered as active
  • paused - this state indicates that the subscription has been paused. Only subscriptions in active state can be paused
  • halted - this state indicates that the subscription, which was initially in pending state, has its mandate expired causing to forceful termination of the subscription
  • cancelled - this state indicates that the subscription has been cancelled and can no longer be continued
  • completed - this state indicates that the subscription has completed all its billing cycles and is now terminated
info

Please note statuses halted, cancelled, completed mark the subscription as terminated, post which it cannot be interacted with.