Skip to main content
The PlanChange event fires whenever a user upgrades or downgrades the plan associated with your installed app. The payload includes both the previous plan ID and the new plan ID, giving you a complete picture of the transition. Use this event to adjust feature entitlements, update billing records in external systems, or trigger plan-specific onboarding or offboarding steps.

​
Payload

FieldTypeDescription
typestringAlways "PLAN_CHANGE"
appIdstringID of the app whose plan was changed
locationIdstringSub-account ID if the plan change occurred at the location level
companyIdstringAgency ID associated with the account
userIdstringID of the user who initiated the plan change
currentPlanIdstringID of the plan the account was on before the change
newPlanIdstringID of the plan the account has switched to

​
Example payload

{
  "type": "PLAN_CHANGE",
  "appId": "ve9EPM428h8vShlRW1KT",
  "locationId": "otg8dTQqGLh3Q6iQI55w",
  "companyId": "otg8dTQqGLh3Q6iQI55w",
  "userId": "otg8dTQqGLh3Q6iQI55w",
  "currentPlanId": "66a0419a0dffa47fb5f8b22f",
  "newPlanId": "77b1530b1egg58gc6g9c33g"
}
  • App Install — fires at initial installation and includes the starting plan
  • OAuth 2.0 — authorization and app management overview
Last modified on March 4, 2026