Subscriptions
List all subscriptions
This endpoint retrieves all active subscriptions.
GET
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Page number.
Example:
1
Number of records per page.
Example:
20
The customer external unique identifier (provided by your own application)
Example:
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
The unique code representing the plan to be attached to the customer. This code must correspond to the code property of one of the active plans.
Example:
"premium"
If the field is not defined, Lago will return only active
subscriptions. However, if you wish to fetch subscriptions by different status you can define them in a status[] query param. Available filter values: pending
, canceled
, terminated
, active
.
Available options:
pending
, canceled
, terminated
, active
Example:
["active", "pending"]
Response
200
application/json
List of subscriptions
The response is of type object
.