subscription.cancellation_scheduled

{ "event": "subscription.cancellation_scheduled", "timestamp": "2026-06-23T14:30:00.000Z", "organizationId": "8f14e45f-ceea-4e7a-9c3d-1c2b3a4d5e6f", "mode": "live", "apiVersion": "2026-08-27", "data": { "subscriptionId": "sub_1a2b3c4d", "customerId": "user_123", "status": "active", "canceledAt": "2026-04-20T10:15:00.000Z", "cancelReason": "Too expensive", "effectiveAt": "2026-04-25T00:00:00.000Z" } }

Cancellation lifecycle

This event marks the start of the cancellation lifecycle. The subscription stays fully usable until effectiveAt:

Moment	Event	status	What to do
Customer requests cancellation	`subscription.cancellation_scheduled`	`active`	Show “ending on {effectiveAt}” in your UI. Do NOT revoke access.
Customer reverts the cancellation	`subscription.cancellation_revoked`	`active`	Remove the “ending on” notice.
Billing period ends	`subscription.canceled`	`canceled`	Revoke access.

subscription.updated also fires at the scheduling moment for backward compatibility — if you already handle the scheduled-cancel state through subscription.updated, you can keep doing so. This event carries the same intent with an explicit name and the exact effectiveAt.

Body

application/json

string

required

event

string

required

Allowed value: "subscription.cancellation_scheduled"

timestamp

string

required

organizationId

string

required

mode

enum<string>

required

Available options:

live,

sandbox

apiVersion

string

required

data

object

required

Show child attributes

Response

200

Return any 2xx status code to acknowledge receipt of the event.

Overview

Events

subscription.cancellation_scheduled

Cancellation lifecycle

Body

Response

​Cancellation lifecycle

Body

Response

Cancellation lifecycle