{
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event_timestamp": "2023-11-07T05:31:56Z",
"is_livemode": true,
"external_id": "<string>",
"subscription": {
"subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": true,
"price_point": {
"ident": "<string>",
"currency": {
"code": "<string>",
"minor_units": 123,
"title": "<string>",
"symbol": "<string>"
},
"features": [
{
"ident": "<string>"
}
],
"lifetime_price": 123,
"intro_free_trial_period": 123,
"intro_paid_trial_price": 123,
"intro_paid_trial_period": 123,
"next_price": 123,
"next_period": 123
},
"status": [
"<string>"
],
"started_at": "2023-11-07T05:31:56Z",
"current_period_starts_at": "2023-11-07T05:31:56Z",
"current_period_ends_at": "2023-11-07T05:31:56Z",
"next_check_at": "2023-11-07T05:31:56Z",
"iteration": 123,
"available_actions": [],
"initial_order_metadata": {},
"next_payment_at": "2023-11-07T05:31:56Z",
"unused_premium_after_pause": 123
},
"user": {
"external_id": "<string>",
"email": "<string>",
"email_aliases": [
"<string>"
]
},
"order": {
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"currency_code": "<string>",
"external_id": "<string>",
"user_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_order_metadata": {},
"psp": "<string>",
"subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"oneoff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"psp_store_id": "<string>",
"retry_step": 123,
"created_at": "2023-11-07T05:31:56Z",
"decline_reason": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"decline_type": "<string>"
}
}
}Webhook reference
Subscription
WEBHOOK
subscription
{
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event_timestamp": "2023-11-07T05:31:56Z",
"is_livemode": true,
"external_id": "<string>",
"subscription": {
"subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": true,
"price_point": {
"ident": "<string>",
"currency": {
"code": "<string>",
"minor_units": 123,
"title": "<string>",
"symbol": "<string>"
},
"features": [
{
"ident": "<string>"
}
],
"lifetime_price": 123,
"intro_free_trial_period": 123,
"intro_paid_trial_price": 123,
"intro_paid_trial_period": 123,
"next_price": 123,
"next_period": 123
},
"status": [
"<string>"
],
"started_at": "2023-11-07T05:31:56Z",
"current_period_starts_at": "2023-11-07T05:31:56Z",
"current_period_ends_at": "2023-11-07T05:31:56Z",
"next_check_at": "2023-11-07T05:31:56Z",
"iteration": 123,
"available_actions": [],
"initial_order_metadata": {},
"next_payment_at": "2023-11-07T05:31:56Z",
"unused_premium_after_pause": 123
},
"user": {
"external_id": "<string>",
"email": "<string>",
"email_aliases": [
"<string>"
]
},
"order": {
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"currency_code": "<string>",
"external_id": "<string>",
"user_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_order_metadata": {},
"psp": "<string>",
"subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"oneoff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"psp_store_id": "<string>",
"retry_step": 123,
"created_at": "2023-11-07T05:31:56Z",
"decline_reason": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"decline_type": "<string>"
}
}
}Body
application/json
Sent when a subscription changes state. Subtypes describe changes across the subscription lifecycle:
- STARTING_TRIAL - Trial period starts
- CONVERTION - Trial converts to paid subscription
- RENEWING - Subscription renews (regular charge)
- UNSUBSCRIPTION - User cancels subscription (auto-renewal disabled)
- PLANNING_POSTPONED_SUBSCRIPTION - Subscription with UPCOMING status scheduled to start when delayed_start migration is used
- PAUSING - Subscription paused
- DEFERRING - Next charge date postponed
- RESUMING - Paused subscription resumes
- RECOVERING_AUTORENEW - Auto-renewal restored after failure
- EXPIRATION - Subscription expired
- UNKNOWN - Unknown or unclassified event
- START_GRACE - Grace period starts after failed charge
- START_RETRY - Retry attempts start without grace period
- FINISH_GRACE - Grace period ends
- RECOVERING - Recovered from grace/retry state
Available options:
subscription, oneoff, order, refund, user, dispute Available options:
starting_trial, convertion, renewing, unsubscription, planning_postponed_subscription, pausing, defering, resuming, recovering_autorenew, expiration, unknown, start_grace, start_retry, finish_grace, recovering Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
