API Lifecycle & Deprecation Policy
This policy is no longer in effect.
Deprecation Date: August 15, 2021
The current policy is available at: API Lifecycle & Deprecation Policy.
The API Lifecycle & Deprecation Policy is part of our API terms and conditions of use. We may make periodic updates to this Policy, at which time we will notify those who have agreements with us.
API Version Status
- Active: An active API version is the most current and fully supported API. It is the recommended version to use by everyone.
- Deprecated: A deprecated API version has been superseded by a newer API version. It is supported (bug fixes) for six months from the deprecation date. New apps will be denied access to deprecated APIs.
- Retired: A retired API version is no longer supported. It includes any API deprecated for more than six months. Any application using a retired API must migrate to an active API.
- Decommissioned: A decommissioned API version is no longer available on production. This occurs after three (3) months of inactivity in Retired state.
API Version Status Table
| Active | Deprecated | Retired | Decommissioned |
|---|---|---|---|
| API is live in production. | API is live in production. | API is live in production. | API is NOT available in production after three (3) months of inactivity in Retired status. |
| Documentation*: Available for review 2 weeks prior to launch; Posted day of launch. | Documentation: Deprecated status indicated and posted on day of deprecation. | Documentation: Retired status indicated and posted on day of retirement. | Documentation: n/a |
| Support: Updated with bug fixes and new features are available. | Support: Updated with bug fixes for first six (6) months; No fixes after that period. | Support: No longer supported six (6) months after Deprecated. | Support: None. |
| Release Notes: Notify 2 weeks prior to launch; Announce availability when in production. | Release Notes: Notify 90 days prior to deprecation; Announce when deprecated. | Release Notes: Notify 90 days prior to retirement; Announce when retired. | Release Notes: Notify 90 days prior to decommissioning. |