Introduction

Welcome to the API Version 2024-07. This version introduces several new features, improvements, and fixes to enhance the functionality and performance of our API. Please read through the following sections to understand the changes and how to implement them.

API versions

Making requests to an API version

Recurpay API versions are declared in the URLs that your app makes requests to:

• REST Admin API URL: /admin/api/{api_version}/{endpoint}

For example, the following URLs make requests to version 2024-07:

• Rest Admin API URL: /admin/api/2024-07/plans

Recurpay's API responses contain the header X-Recurpay-API-Version, which returns the API version that was used to execute the request. When you keep your app updated, this matches the API version that's specified in your request. If the returned version is different, then your app is out of date and is using the default API version.

New introduction with this version

• Introduction on advance shipping with control or Local Shipping & Pickups.
• Introduction of filtering in URL paramerter.
• Introduction of webhook events.
• Plans have cutoff anchors set by API.
• Customer information update API.