Breaking Change Policy

API Updates and Breaking Change Policy

We version our APIs when breaking changes are made. Breaking changes include:

  • A change in the format or schema of a response.
  • A change in response type.
    *API deletions or removals of functionality.

We consider the following changes to be non-breaking and backward-compatible, and as such they will not result in up-versioning of the API:

  • Adding new endpoints or HTTP methods
  • Adding new response parameters or fields
  • Adding new optional request fields

In rare cases we will need to make a breaking API change, typically in order to resolve a critical issue. In these cases, we will make every attempt to communicate the change to all users, and give a specific time that the change will take place.​