Intro to API Versions

Chargeflow employs path parameter-based version management for its APIs. Dedicated to developers' experience, we have implemented a date-based API version.

Using API Versions

You can select the API version by modifying the path parameter by replacing the {apiVersion} placeholder:

https://api.chargeflow.io/public/{apiVersion}/...

For example:

https://api.chargeflow.io/public/2024-03-18/...

All available API versions are listed in the documentation Available API Versions

Deprecation of API Methods

During significant updates, Chargeflow may mark specific API methods of a version as deprecated. When a method is marked as deprecated, it indicates that it will no longer be available for usage in upcoming versions. This allows users ample time to prepare in advance, facilitating a smooth transition to the new version at the earliest opportunity.