Skip to main content

Scheduled plan change lifecycle

Interval direction takes precedence: a shorter interval is scheduled for the end of the paid period and a longer interval changes immediately. When the interval is unchanged, Plan Groups use sortOrder: lower-ordered plans are scheduled and higher-ordered plans change immediately. Paid-to-free changes are always scheduled. Immediate upgrades skip this event entirely — they fire subscription.plan_changed right away.

Body

application/json
id
string
required
event
string
required
Allowed value: "subscription.plan_change_scheduled"
timestamp
string
required
organizationId
string
required
mode
enum<string>
required
Available options:
live,
sandbox
apiVersion
string
required
data
object
required

Response

200

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