API Model for Stripe Service

We have set the background for modeling the API for Stripe by deciding on various technical aspects in the previous lesson. In this lesson, let’s dive deeper and model the Stripe API by discussing various endpoints, the request and response structure, and other relevant concepts.

Let's start by deciding the base URL for our API.

Base URL and endpoints

We consider the following base URL for our proposed Stripe API that we will consider in the following sections:

Here, the api.stripe.com represents the domain while the v1.0 shows the API version. In our model, we consider v1.0 as the first version of our API. Similarly, service represents any service that our Stripe API provides to its users—for example, invoices, charges, refunds, and so on. We will also perform various operations using the given URL, so this will be a part of our discussion throughout this lesson.

Stripe consists of various services, and each service has multiple endpoints to operate on. Therefore, we have shown each endpoint in the following figure against each service for simplicity. You can unfold a specific branch's service details by clicking the filled dots (circles).

Note: Since most of the above endpoints perform similar operations, we discuss details of selected endpoints based on their significance to avoid redundant request-response messages. The rest of the services are summarized in the table at the end of this lesson.

Preconditions

Prior to ...