Subscription lifecycle events
Use these tables to see how subscription events affect the subscription status, item status, and renewal type. Each table also shows the API notifications sent to you and the emails sent to the customer.
The tables show Subscription Management 2.0 by default. Select the other tab to view the corresponding behavior in Subscription Management 1.0.
- Subscription Management 2.0
- Subscription Management 1.0
Initial purchase (sign-up)
See the resulting statuses and renewal type after a customer signs up.
| Event | Subscription | Item | Renewal | Notifications |
|---|---|---|---|---|
| Sign up for subscription with automatic renewal (online payment) | A | A | A | EmailInvoice (receipt) |
| Sign up for subscription with manual renewal (online payment) | D | R | M | EmailInvoice (receipt) |
| Sign up for subscription with manual renewal (offline payment) | D | R | M | EmailOrder confirmation |
| Sign up for subscription with automatic renewal (offline payment) | N | A | A | EmailOrder confirmation |
| Sign up for subscription with fraudulent credit card data | N | A | AorM | EmailPayment declined |
Legend
NewActiveAwaiting reinstateDeactivatedAutomatic renewalManual renewal
Renewals and other subscription events
Follow how each event changes the subscription and item statuses.
| Event | Subscription change | Item change | Notifications |
|---|---|---|---|
| Cancel subscription; Deactivate Subscription Item | Achanges toD | Achanges toD | EmailCancel notification |
| Reactivate subscription; Reinstate Subscription Item | Dchanges toA | Dchanges toA | EmailReinstated notification |
| Cancel a subscription item; Deactivate Subscription Item | Achanges toA | 1Achanges toD 2Achanges toA | EmailCancel notification |
| Reactivate a subscription item; Reinstate Subscription Item | Achanges toA | 1Dchanges toA 2Achanges toA | EmailReinstated notification |
| Retire subscription for a discontinued product; Deactivate Subscription Item | Achanges toD | Achanges toF | EmailCancel notification |
| Remove a discontinued subscription item; Remove Subscription Item | Achanges toA | 1Achanges toX 2Achanges toA | APINone EmailUpdate notification can be sent via API |
| Cleverbridge doesn’t receive payment by renewal date—grace period activated | Achanges toG | Achanges toA | EmailOn grace notification |
| Cleverbridge receives payment during grace period | Gchanges toA | Achanges toA | EmailInvoice (receipt) |
| Cleverbridge doesn’t receive payment by end of grace period | Gchanges toH | Achanges toA | EmailOn hold notification |
| Cleverbridge doesn’t receive payment by renewal date—no grace period | Achanges toH | Achanges toA | EmailOn hold notification |
| Cleverbridge receives payment while subscription is on hold | Hchanges toA | Achanges toA | EmailInvoice (receipt) |
| Cancel subscription item while subscription is on hold; Deactivate Subscription Item | Hchanges toD | Achanges toD | EmailCancel notification |
Legend
ActiveGraceHoldDeactivatedFinishedRemovedBeforeAfter
Reimbursement events
Compare the subscription, item, and renewal values before and after each event.
| Event | Subscription change | Item change | Renewal change | Notifications |
|---|---|---|---|---|
| Issue a full refund for a subscription transaction | Achanges toA | Achanges toA | AorMchanges toAorM | EmailRefund |
| Issue a full refund for a subscription transaction and terminate subscription | Achanges toD | Achanges toA | AorMchanges toM | EmailRefund |
| Issue a partial refund for a subscription transaction | Achanges toA | Achanges toA | AorMchanges toAorM | EmailRefund |
| Issue a partial refund for a subscription transaction and terminate subscription | Achanges toD | Achanges toD | AorMchanges toAorM | EmailRefund / Cancel notification |
| Issue a refund for a subscription item transaction | Achanges toA | 1Achanges toA 2Achanges toA | AorMchanges toAorM | EmailRefund |
| Issue a refund for a subscription item transaction and terminate subscription item | Achanges toA | 1Achanges toD 2Achanges toA | AorMchanges toAorM | EmailRefund / Cancel notification |
| Refund VAT for a subscription transaction | Achanges toA | Achanges toA | AorMchanges toAorM | EmailRefund |
| Process a chargeback for a subscription transaction | Achanges toD | Achanges toA | AorMchanges toAorM | EmailChargeback information / Cancel notification |
Legend
ActiveDeactivatedAutomatic renewalManual renewalBeforeAfter
Initial purchase (sign-up)
See the resulting statuses and renewal type after a customer signs up.
| Event | Subscription | Item | Renewal | Notifications |
|---|---|---|---|---|
| Sign up for subscription with automatic renewal (online payment) | A | A | A | EmailInvoice (receipt) |
| Sign up for subscription with manual renewal (online payment) | D | R | M | EmailInvoice (receipt) |
| Sign up for subscription with manual renewal (offline payment) | D | R | M | EmailOrder confirmation |
| Sign up for subscription with automatic renewal (offline payment) | N | A | A | EmailOrder confirmation |
| Sign up for subscription with fraudulent credit card data | N | A | A | EmailPayment declined |
Legend
NewActiveAwaiting reinstateDeactivatedAutomatic renewalManual renewal
Renewals and other subscription events
Follow how each event changes the subscription and item statuses.
| Event | Subscription change | Item change | Notifications |
|---|---|---|---|
| Cancel subscription; Deactivate Subscription Item | Achanges toD | Achanges toD | EmailCancel notification |
| Reactivate subscription; Reinstate Subscription Item | Dchanges toA | Dchanges toA | EmailReinstated notification |
| Cancel a subscription item | Achanges toA | 1Achanges toD 2Achanges toA | EmailCancel notification |
| Reactivate a subscription item | Achanges toA | 1Dchanges toA 2Achanges toA | EmailReinstated notification |
| Retire subscription for a discontinued product; Deactivate Subscription Item | Achanges toD | Achanges toF | EmailCancel notification |
| Remove a discontinued subscription item | Achanges toA | 1Achanges toX 2Achanges toA | APINone EmailUpdate notification can be sent via API |
| Cleverbridge doesn’t receive payment by renewal date—grace period activated | Achanges toG | Achanges toA | EmailOn grace notification |
| Cleverbridge receives payment during grace period | Gchanges toA | Achanges toA | EmailInvoice (receipt) |
| Cleverbridge doesn’t receive payment by end of grace period | Gchanges toH | Achanges toA | EmailOn hold notification |
| Cleverbridge doesn’t receive payment by renewal date—no grace period | Achanges toH | Achanges toA | EmailOn hold notification |
| Cleverbridge receives payment while subscription is on hold | Hchanges toA | Achanges toA | EmailInvoice (receipt) |
| Cancel subscription item while subscription is on hold; Deactivate Subscription Item | Hchanges toD | Achanges toD | EmailCancel notification |
Legend
ActiveGraceHoldDeactivatedFinishedRemovedBeforeAfter
Reimbursement events
Compare the subscription, item, and renewal values before and after each event.
| Event | Subscription change | Item change | Renewal change | Notifications |
|---|---|---|---|---|
| Issue a full refund for a subscription transaction | Achanges toA | Achanges toA | AorMchanges toAorM | EmailRefund |
| Issue a full refund for a subscription transaction and terminate subscription | Achanges toD | Achanges toA | AorMchanges toAorM | EmailRefund / Cancel notification |
| Issue a partial refund for a subscription transaction | Achanges toA | Achanges toA | AorMchanges toAorM | EmailRefund |
| Issue a partial refund for a subscription transaction and terminate subscription | Achanges toD | Achanges toD | AorMchanges toAorM | EmailRefund / Cancel notification |
| Issue a refund for a subscription item transaction | Achanges toA | 1Achanges toA 2Achanges toA | AorMchanges toAorM | EmailRefund |
| Issue a refund for a subscription item transaction and terminate subscription item | Achanges toA | 1Achanges toD 2Achanges toA | AorMchanges toAorM | EmailRefund / Cancel notification |
| Refund VAT for a subscription transaction | Achanges toA | Achanges toA | AorMchanges toAorM | EmailRefund |
| Process a chargeback for a subscription transaction | Achanges toD | Achanges toA | AorMchanges toAorM | EmailChargeback information / Cancel notification |
Legend
ActiveDeactivatedAutomatic renewalManual renewalBeforeAfter