API change policy - ION Manual

How changes are handled

Non-breaking changes require no action from you. These include adding new fields and expanding functionality in ways that don’t affect existing calls. They appear in the release notes. When a breaking change is unavoidable, ION does the following:

• Announces it at least 14 days before production rollout.
• Explains why the change is necessary.
• Schedules deprecation after monitoring API usage.
• Provides before and after API examples.
• Communicates through in-app notices, release notes, and updated documentation.

What this means for you

Watch the release notes and API change alerts to stay up to date.

Example breaking-change notice

An announcement looks like this:

Breaking change notice, effective July 28
The Approved and Requested PO Line statuses are being deprecated. Reference the Purchase Order status instead.
Action required: Update any API calls, webhooks, or rules that use these statuses before July 28.
Why: This simplifies the PO flow. It avoids inconsistent status handling.
What’s next: See the migration guide for examples and updated API payloads.

For a running record of changes, see the Changelog.