General Deprecation Policy

As the Smart CPQ API evolves, APIs are periodically reorganized or upgraded. Whenever possible, APIs are updated so that they are compatible with earlier versions (according to the OpenAPI standard).

When the changes don’t allow a backward compatibility and the old API can’t be supported indefinitely, the old API is deprecated and guidance is provided to help replace the deprecated API.

The deprecation period is 12 months. During this time, the deprecated API will be supported. The first major version following the 12 month deprecation period will be the end of life: the deprecated API will be removed and no longer supported.

In very rare cases, a different policy may need to be applied, and in that case, a specific communication will be made through appropriate channels.

No exception to this policy can be granted to customers. We encourage customers to subscribe and pay attention to the following notices.

Notice of Deprecation and Removal

Notices of API deprecation are issued through the following channels at least 12 months before the proposed end of life date:

Release Notes

The Release Notes available on Connect include an announcement section where deprecated APIs are called out.

API Change Logs

Specific API change log documents are published on Connect no later than two weeks before the software update which include all API changes: Deprecation and API removal at end of life.

Swagger Documentation

The API documentation, available on Connect as a Javadoc, online on buildwith.pros.com, or accessed online from your Smart CPQ environment, will display a Deprecated tag jointly with the replacement guidance.

The version in which the API has been deprecated will be mentioned as well as the removal date.

OpenAPI Contracts

The JSON API contract that can be retrieved directly from the API documentation, or the yaml contract available on Connect, have the deprecated flag.

Sunset API HTTP Response Header [As of version 12.18]

To check automatically for API deprecation and sunset you can check for 'Deprecation' and 'Sunset' HTTP response standard headers. They contain both an HTTP date to indicate when the API was deprecated and when it will be deleted (sunset), if sunset date is known. You can find more information on API replacement in the deprecated API documentation.

All public APIs can send both or one of these headers if they are deprecated.