Skip to main content
Stora uses dated API versions to let you plan upgrades without unexpected changes to your integration. A version defines the contract for versioned REST API resource requests, responses, and webhook payloads.
The current API version is 2025-09. Review its OpenAPI specification or the changelog.

​
How API versions work

Versioned resource endpoints use the YYYY-MM format in the request path:
For resource endpoints, the path determines the version used for API requests and responses. OAuth 2 token endpoints under /oauth2/ are not date-versioned. Webhook endpoints also store an API version, which determines the structure of their payloads. See Webhooks for setup details.

​
Compatibility within a version

Stora does not introduce breaking changes within a published API version. A breaking change requires a new dated version. We may make backward-compatible changes within a version, including:
  • Adding an endpoint
  • Adding an optional request field
  • Adding a response field
  • Deprecating a field while keeping it available
  • Fixing behavior so it matches the documented contract
Your integration should ignore response fields it does not recognize so that compatible additions do not disrupt it. Changes that require a new version include:
  • Removing or renaming an endpoint or field
  • Changing a field’s type
  • Making an optional request field required
  • Changing documented behavior in a way that requires client changes

​
Version lifecycle

Each API version passes through four lifecycle milestones: Enterprise customers continue to receive maintenance support during months seven through twelve. If Stora releases multiple versions within twelve months, their support windows may overlap. For example, if a version is deprecated on May 15, 2026, the last supported day is November 30, 2026 for Standard customers and May 31, 2027 for Enterprise customers.

​
Supported versions

The current version has no scheduled retirement date. When we release a successor, we add separate Standard and Enterprise last supported days and link its dedicated migration guide.

​
Deprecation notifications

When Stora releases a new API version, we publish the previous version’s deprecation date, Standard last supported day, Enterprise last supported day, and migration guide:
  • On this page
  • In the changelog
  • By email to developers registered in the Developer Portal
Stora may use a shorter timeline only when necessary to address a serious security, privacy, legal, or regulatory risk. We will communicate the reason and revised timeline as early as possible through the same notification channels.

​
Migrate to a new version

We publish a dedicated migration guide with every new API version. The guide explains each breaking change and the work required to move from the previous version. We link it from the supported-versions table, changelog, and deprecation email.
1

Follow the migration guide

Work through the release-specific migration guide for your current and target versions.
2

Review the supporting references

Check the changelog and new OpenAPI specification for complete request, response, and webhook schemas.
3

Update API requests

Replace the version in your API request paths and update your integration for the new contract.
4

Update webhook endpoints

Change each webhook endpoint to the new API version so its payloads use the new structure. See Webhooks for endpoint configuration.
5

Test and deploy

Test affected API calls and webhook handlers, then deploy before your applicable Standard or Enterprise last supported day.