To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Fired when a Kademi platform subscription changes state - started, payment due, payment failed, payment succeeded or expired. This is about the licence an account holds for Kademi itself, not about a member subscribing to a group. It is raised by the subscription service when a trial or paid subscription is created, and by the nightly subscription processor when a licence enters its advance payment window or lapses without renewal. Which of those happened is given by getEventAction. It is dispatched to the funnels system as a funnel event, so it can begin or advance a journey - typically a billing reminder or dunning sequence aimed at the subscription's billing contact, which is the profile returned by getLeadProfile.
Group: Journeys
Implements: FunnelEvent, Event
Properties
| Property | Returns | Description |
|---|---|---|
| eventAction | EventAction | Which subscription state change this event represents: STARTED, PAYMENT_DUE, PAYMENT_FAILED, PAYMENT_SUCCEEDED or EXPIRED. |
| leadProfile | Profile | The billing contact on the subscription, used as the person a funnel journey started from this event applies to. Null if the subscription has no billing contact set. |
| relatedLead | Lead | Always null for this event - a subscription change is not raised against an existing funnel lead. |
| subscription | KademiSubscription | The subscription whose state changed, carrying the product, expiry date and billing details. |
Methods
getLeadProfile()
Returns: Profile
The billing contact on the subscription, used as the person a funnel journey started from this event applies to. Null if the subscription has no billing contact set.
getEventAction()
Returns: EventAction
Which subscription state change this event represents: STARTED, PAYMENT_DUE, PAYMENT_FAILED, PAYMENT_SUCCEEDED or EXPIRED.
getSubscription()
Returns: KademiSubscription
The subscription whose state changed, carrying the product, expiry date and billing details.
getRelatedLead()
Returns: Lead
Always null for this event - a subscription change is not raised against an existing funnel lead.
© 2025 Kademi Ltd