Reference

Versioning

What the API version on every event means.

Every event carries apiVersion (2026-10-01), also sent as the Protected-Pay-Api-Version webhook header. It names the shape of the event object.

  • Adding a field, an event type, an enum value, an error code, or an optional parameter is not a breaking change. Ignore what you do not recognise.
  • Removing or renaming a field, or changing its meaning, would come with a new dated version.