SubscriptionEvents
Returns all events that have occurred for a specific Square subscription, including plan changes, phase transitions, cancellations, and other subscription lifecycle updates.
Table Specific Information
Select
The server will execute all filters to this view client-side, in memory.
Retrieve the list of all subscription events for a subscription id. The Subscription Id is required to access the view.
SELECT * from SubscriptionEvents where Id = 'fd9d6200-bb12-43c5-9973-070bfc6f5e05'
Columns
| Name | Type | Description |
| Id [KEY] | String | Unique Id of the subscription event. |
| SubscriptionEventType | String | Type of event that occurred for the subscription, such as creation, plan change, pause, resume, or cancellation. |
| PlanVariationId | String | The Id of the subscription plan variation associated with the subscription. |
| EffectiveDate | Datetime | The YYYY-MM-DD-formatted date when the subscription event occurred. |
| InfoDetail | String | A human-readable explanation providing context for the event (for example, 'Customer upgraded from Basic to Premium plan.'). |
| InfoCode | String | An info code indicating the subscription event that occurred. |
| PhasesUID | String | The Id of the subscription phase. |
| PhasesOrdinal | Int64 | The index of the phase in total subscription plan. |
| PhasesOrderTemplateId | String | The Id of the order to be used in billing. |
| PhasesPlanPhaseUID | String | UID of the plan's phase as defined in the catalog. |
| SubscriptionId | String | The Id of the subscription associated with the event. |