API Lifecycle and Versioning

To provide you with the best possible product experience, we continuously improve our services. As a result, API changes are inevitable. In some cases, we may need to deprecate or sunset APIs due to security updates, legal requirements, performance improvements, redundancy, or other important reasons.

We understand that breaking changes require effort on your side. That's why we strive to minimize them and support you throughout the transition process.

API Lifecycle Stages

Stage	Description
`Not Active`	Endpoints are defined but not yet available.
`Beta`	Endpoints may change at any time, including breaking changes, with or without prior notice.
`Active`	Stable endpoints with full support. Breaking changes are rare and follow a formal deprecation process.
`Deprecated`	Endpoints remain available but are no longer actively maintained (except for critical security issues).
`Sunset`	The deprecation period has ended and the endpoint is no longer accessible.

Beta

Endpoints in this stage are clearly marked as such in the documentation.
They may change at any time without prior notice.
Feedback is welcome via your usual communication channels with us (e.g., Slack or email).

Active

We may introduce non-breaking enhancements, such as new optional fields.
You'll be notified of changes through release notes.
If we introduce breaking changes (e.g., removing or making fields mandatory), we’ll follow the deprecation process outlined below.

Deprecated

Deprecated endpoints are clearly marked and, where possible, we suggest alternatives.
We provide at least six months' notice before removing functionality or introducing breaking changes.
Exceptions apply in cases of legal, security, or third-party requirements, where less notice may be given.
Pliant is not liable for issues arising from the continued use of deprecated APIs.

Important Notes

All breaking and non-breaking changes are announced via our regularly updated API changelog.
In case of breaking changes, we will proactively contact you to coordinate and support migration.

API Versioning

You can specify a particular API version by sending the Pliant-API-Version HTTP header with your request.
This allows you to continue to use a stable version, even as newer versions are released.

If the version is:

Active: The response will match the requested version structure.
Deprecated (but not sunset): The response will still be served as requested.
Sunset: The version is no longer supported and requests will fail.

Example:

Pliant-API-Version: 2.0.0

Pliant-API-Version: 2.1.0