Skip to content

Subscription.switched

Emitted each time a Subscription is switched.

Subscription.switch emits Subscription.switched when it completes on a Subscription.

PropertyValue
Emitted bySubscription.switch
NounSubscription
WakesNone.

Payload

Each delivery is an Event record. data holds what Subscription.switch returns.

FieldTypeRequiredDescription
namestringrequiredSubscription.switched.
atdatetimerequiredWhen it happened.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
datajsonrequiredThe Thing as the Action left it.
data.subscriptionSubscriptionrequiredThe Subscription on its new Offer.
data.subscription.statusstringrequiredOne of active, trialing, pastDue, paused, incomplete, or canceled.
data.subscription.renewsAtdatetimeWhen it next renews.
data.subscription.quantityintegerHow many units of the Offer’s Price it holds, such as 12 members; 1 by default.
data.subscription.trialEndsAtdatetimeWhen a trial ends and the first paid period starts.
data.subscription.termEndsAtdatetimeWhen a committed term ends; the Renewal and the renewal notice read it.

Example

JSON
{
  "$id": "https://api.sb/routewise.dev/events/event_1",
  "$type": "Event",
  "name": "Subscription.switched",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "subscription": {
      "$id": "https://api.sb/routewise.dev/subscriptions/subscription_1",
      "$type": "Subscription",
      "status": "active",
      "renewsAt": "2026-10-22T12:00:00Z",
      "quantity": 1,
      "trialEndsAt": "2026-10-22T12:00:00Z",
      "termEndsAt": "2026-10-22T12:00:00Z"
    }
  },
  "seq": 1
}