Membership events
Subscribe to individual membership lifecycle and payment changes, or changes to the membership types offered by your organisation.
A membership renewal is emitted when its committed period start moves forward or a manual renewal completes. Mid-term upgrades and added extras do not emit renewal events. Expiring notifications apply to active, non-renewing memberships within seven days of their expiry date, once per expiry date. Date-driven expiry is checked hourly, with a 90-day recovery window; renewing memberships do not expire merely because their billing period ends. Historical expiry notifications only go to endpoints created before that expiry date.
Membership
| Event | When it is sent |
|---|---|
membership.created | The resource is created, including pending checkout or payment records |
membership.updated | Public resource fields change |
membership.activated | The membership becomes active |
membership.renewed | A new membership period is committed or a manual renewal completes |
membership.expiring | An active, non-renewing membership is within seven days of expiry |
membership.expired | The membership reaches expiry |
membership.cancellation_scheduled | Cancellation is scheduled for the end of the current period |
membership.cancellation_revoked | A scheduled cancellation is withdrawn |
membership.cancelled | The resource is cancelled |
membership.payment_succeeded | A payment succeeds |
membership.payment_failed | A payment fails |
membership.refund_created | An individual refund is created |
membership.refund_succeeded | An individual refund succeeds |
membership.refund_failed | An individual refund fails or is cancelled by the provider |
Membership type
| Event | When it is sent |
|---|---|
membership_type.created | The resource is created |
membership_type.updated | Public resource fields change |
membership_type.archived | The membership type is made inactive |
membership_type.deleted | The resource is deleted |
Example payload
This example illustrates membership.activated. Available fields depend on the resource and the action.
{
"id": "evt_example",
"event": "membership.activated",
"timestamp": "2030-05-01T18:00:00.000Z",
"organisation_id": "507f1f77bcf86cd799439010",
"schema_version": "1",
"source": "admin",
"data": {
"membership": {
"id": "507f1f77bcf86cd799439011",
"company": "507f1f77bcf86cd799439010",
"member": "507f1f77bcf86cd799439011",
"membershipType": "507f1f77bcf86cd799439011",
"status": "active",
"amount": 2500,
"currency": "gbp",
"cancelAtPeriodEnd": false
}
}
}
See delivery and security for the shared envelope, signature verification, retry behavior, and delivery guarantees. Use subscription management to preview sample data for every supported event and send test deliveries.