Skip to main content

Retail Services Platform API

Overview

This page provides detailed information on the various API methods available for the Retail Services platform. Each section provides comprehensive descriptions, usage guidelines, and examples to help our partners effectively utilize the designed API.

The API methods are divided into the following sections:

  • Account-related methods: provide key functionalities on account management, such as account creation, retrieving account details by ID or email, resetting a password, and updating an email address.

  • Subscription-related methods: cover the processes involved in subscription management, including subscription activation, confirmation, and cancellation, and retrieving information on subscriptions.

  • Access token-related methods: provide means for secure user authentication through token generation based on credentials.

  • Profile-related methods: make it possible for an end user to access their personal profile page.

  • Tracking-related methods: provide means on monitoring trial subscriptions for tracking and reporting purposes.

API versioning

Retail Services Platform supports two API versions: API v1 and API v2. These versions are functionally identical, except for one method, Activate subscription (see the Activate subscription v2 description). It is important to note that these APIs are designed to be backward compatible, and while they remain compatible, we do not increment the version number. However, we retain the right to enhance existing methods by introducing new non-mandatory fields in request bodies and responses in order to improve functionality and serve new needs. 

Partner responsibility disclaimer: To accommodate these enhancements, we encourage our partners to be proactive in implementing endpoints on their side. This will ensure a smoother transition when new non-mandatory fields are introduced, preventing any unforeseen disruptions in the workflow.