Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 2.0!

Getting started

Upodi is a customer & subscription management platform that supports 1.000+ business' and over 100.000 subscriptions' in 10 countries around the world. Many of these businesses use the Upodi API to automate and integrate their existing line of business (LOB) solutions.

The API

This is the documentation for the Upodi v2 API. Read the contents of this page carefully.

Upodi API is using HTTP methods and a RESTful endpoint structure, and uses HTTP response codes to indicate API errors. Format requests in JSON and the APIs return JSON-formatted responses. Upodi API do not support XML content negotiation.

A resource can support the following basic REST API actions (that are actually HTTP methods):

  • GET for retrieving the resource
  • POST for creating the resource
  • PUT for modifying the resource
  • DELETE for removing the resource

Upon updating data, the full object must be retrieved and returned. Our API does not provide property-by-property update. Issue a GET, provide changes then a PUT.

  • PATCH is not supported (property update)

We make changes to the APIs from time to time. For more information, see API Changes.

🚧

Latest Upodi API endpoint:

https://api.upodi.io/v2/

Requests

To perform an API action you need to make an API request. For HTTP POST and PUT method, the Upodi API accepts application/json media type.

To ensure requests are threated as JSON, please add the ACCEPT header:

Accept: application/json; charset=utf-8

In addition, you must set the CONTENT-TYPE header for every request:

Content-type: application/json; charset=utf-8

Response

An API request, that has been sent to the API service, returns an API response. All responses from the Upodi API will be in JSON. All responses will contain a unique request identifier in the HTTP headers with name Request-Id. The format is a GUID.