docs
  1. SCAYLE Resource Center
  2. Customer Account API
  3. Getting Started
  4. Versioning

Versioning

Current version

1.0.0

The Customer Account API uses URI versioning.

Example URI

https://{{tenant-space}}.checkout.api.scayle.cloud/api

The current version is v1. Whenever making a request to the Customer Account API, you have to specify the version inside the URI.

Backwards-Compatible Changes

When backwards-compatible changes are made to the Customer Account API, no new version is released. Backwards-compatible changes are defined as:

  • Adding new API resources
  • Adding new optional request parameters
  • Adding new properties to responses

Backwards-Incompatible Changes

When backwards-incompatible changes are made to the Customer Account API, a new version is released. Backwards-incompatible changes are defined as:

  • Deleting existing API resources
  • Adding new required parameters to existing API methods
  • Removing properties from an existing API response
  • Changing data types of existing properties

Release Notes

For details about updates to the Customer Account API, see the release notes.