Understand the subscription lifecycle

Learn how Pine Labs Online subscriptions transition through plan creation, mandate registration, pre-debit notifications, auto-debit execution, and terminal states.

Plan Life Cycle

The figure below shows the life cycle of the Plan.

plan-life-cycle

The table below list the various statuses that our Plans can have during its life cycle.

StatusDescription
CREATEDWhen the Create Plan request is successfully created with a future start date.
ACTIVEWhen the plan is activated, i.e., when the scheduled start date and time are reached.
INACTIVEWhen the plan has expired.

Subscription [Mandate Registration] Life Cycle

The figure below shows the life cycle of the Subscription.

mandate-registration-flow

The table below list the various statuses that our Subscription can have during its Mandate registration life cycle.

StatusDescription
CREATEDWhen the Create Subscription request is successfully received by Pine Labs Online.
EXPIREDThis state occurs when no response is received from the partner bank for the create subscription request within 4 hours.
INACTIVEThe mandate creation fails due to a failure response from the acquirer.
TRIALThis state occurs when the mandate is successfully created by your customer. Note: Subscription billing will begin once the trial period ends. After the trial period, the mandate will transition to the ACTIVE state.
ACTIVESubscription is in an active state and can be presented to the customer.
PAUSEDThis state occurs when the subscription is temporarily paused, and billing is currently on hold.
RESUMEDThe subscription transitions to this state when either the merchant or the customer resumes it from a PAUSED or HALTED status.
UPDATINGThis status occurs when the subscription details are requested for modification. Note: Once the customer provides consent, the subscription modification request will be processed, and the subscription will return to the ACTIVE state.
DEBIT FAILEDThe subscription enters this state if the first debit execution request fails and the customer cannot be charged on the initial attempt for a billing cycle.
HALTEDAfter exhausting all retry attempts by both the merchant and Pine Labs Online, the subscription enters the HALTED state. No further actions can be performed while subscription remains in this state.
CANCELLEDThe subscription is successfully cancelled after receiving a callback confirmation from the bank.
COMPLETEDUpon reaching the subscription's end period, the mandate transitions to this final state.

Presentation Life Cycle

The Presentation Life Cycle consists of two distinct flow types:

  1. Pre Debit Notification Flow
  2. Customer Debit Flow

Pre Debit Notification Flow

The figure below shows the life cycle of the Pre Debit Notification flow of Presentation.

pre-debit-notification-flow

The table below list the various states of a Presentation.

StatusDescription
CREATEDWhen we have received the Subscription Notification request successfully.
PENDINGWhen we successfully initiate a Pre-debit Notification.
PAUSEDWhen the subscription is Paused.
CANCELLEDWhen the subscription is Cancelled.
NOTIFIEDWhen the notification is delivered successfully.
FAILEDPre-Debit Notification is unsuccessful, the system automatically retries delivery up to 10 times before marking it as Failed.
PDN FAILEDPre-Debit Notification has failed after all internal retries for a subscription.

Customer Debit Flow

The figure below shows the life cycle of the Customer Debit flow of Presentation.

customer-debit-flow

The table below list the various states of a Presentation.

StatusDescription
CREATEDWhen the create presentation request is successfully received by Pine Labs Online. Note: You need to use our Presentation API only if notification is handled by Pine Labs Online.
PENDINGWhen we successfully initiate a Pre-debit Notification.
PAUSEDWhen the subscription is Paused.
CANCELLEDWhen the subscription is Cancelled.
FAILEDPre-Debit Notification or customer debit fails, the system will attempt up to three retriesโ€”initiated either by the merchant or Pine Labs. After three unsuccessful attempts, the subscription status changes to HALTED. The merchant can then send a new notification and debit request. Once the debit is successful, the subscription returns to the ACTIVE state.
COMPLETEDWhen the debit is successful.
New chat
Responses are generated using AI and may contain mistakes.
Hi! I'm Pine, your AI developer assistant. Ask me anything about Pine Labs APIs, integrations, or troubleshooting.

Tip: you can create a new chat with โŒ˜ + E