Breaking or
Deprecated.
Lifecycle
Every endpoint, field, or flow moves through four stages:| Stage | What it means |
|---|---|
| Active | Fully supported. Safe to build on. |
| Deprecated | Still works, but scheduled for removal. Announced in the changelog with a migration path. Start migrating. |
| Sunset | A fixed end date is set. The behavior still works until that date. |
| Removed | No longer available after the sunset date. |
Breaking vs. non-breaking changes
What counts as non-breaking (no migration required):- New endpoints, resources, or optional request parameters.
- New fields in a response or webhook payload.
- New webhook event types or enum values.
- Removing or renaming an endpoint or field.
- Changing the type or meaning of an existing field.
- Changing an authentication flow.
How we announce changes
When a breaking change or deprecation is scheduled, we use the loudest path available, because this is money infrastructure:- A changelog entry tagged
BreakingorDeprecated, with migration steps. - A direct email to API-key holders.
- An in-dashboard banner for breaking changes.
- The affected endpoint is marked deprecated in the API reference.
Current deprecations
No active deprecations.When something is scheduled for deprecation, it appears here with its deprecation date, sunset date,
and a link to the migration guide.