Skip to main content
Lago API endpoints follow common RESTful standards.

​
Authentication

Most endpoints require authentication with an API key in the Authorization header:

​
HTTP status codes

HTTP status codes communicate the outcome of each API request. For example, a successful request returns 200 OK, while a malformed request returns 400 Bad Request. See Errors for the full list of error codes.

​
Request and response body

Unless otherwise noted, both requests and responses use a JSON body, and the Content-Type header is expected to be set to application/json.

​
Query parameters

Query parameters allow you to filter, search, and paginate API results. The Lago API supports several types of query parameters, described below.

​
Simple parameters

Simple query parameters are key-value pairs. Use them for pagination, or to filter results by a single value:
List subscriptions
The API reference describes this parameter as:
​
string
The customer external unique identifier (provided by your own application)Example: "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

​
Array parameters

Array parameters repeat the same key, which always ends with square brackets ([]). Use them to filter results by multiple values:
List applied coupons
The API reference describes this parameter as:
​
enum<string>[]
The coupon codes to filter the applied coupons by.