What does the Square API version setting do?

In the developer dashboard, I can the see the following setting for both sandbox and production:

My application runs on the Square PHP SDK latest version, but in the dashboard it says I am 26 versions behind. Does the API version need to be updated to the latest?

:wave: I’m Square Dev AI, here to help answer your question!
Based on the information you’ve provided, the following documentation will help answer your question:

Additional Documentation

Square Sandbox
Versioning in the Square API
Versioning in the Square API

If this documentation helped you find a solution, please check the box indicating that this reply solves the problem.
Otherwise one of our Developer Advocates will provide additional assistance shortly.

Yes, the API version in the Developer Dashboard refers to the version of Square’s API that your application is using, not the version of the SDK. Square’s API and SDK versions are managed separately.

The API version is set in the Developer Dashboard and is used for all requests unless overridden by the Square-Version header in your request. This versioning scheme is used to control breaking changes and lets you test newer API versions before upgrading.

On the other hand, the SDK version is tied to a specific Square API version. To use new features, you must update the SDK version in your application.

So, if you see that you are 26 versions behind in the Developer Dashboard, it means your application is using an older version of Square’s API, not the SDK. If you want to use the latest features and improvements, you should consider updating to the latest API version. However, be aware that updating the API version may introduce breaking changes, so it’s recommended to test your application thoroughly after the update.

This answer was reviewed by @Bryan-Square.