/01 API
Receive real-time events when a subscription activates, renews, cancels, or a top-up payment succeeds.
Events
| payment.succeeded | A one-time payment completed successfully (top-up) |
| subscription.active | A new subscription was activated |
| subscription.renewed | A subscription renewed for another billing period |
| subscription.cancelled | A subscription was cancelled |
Payload structure
Every event payload includes a type field and a data object. The metadata field carries user_id, plan, and billing period.
payload
{
"type": "subscription.active",
"data": {
"subscription_id": "sub_abc123",
"metadata": {
"user_id": "uuid",
"plan": "pro",
"billing": "monthly"
}
}
}