GET
/
subscriptions
curl --request GET \
  --url https://api.sulu.sh/v0/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "object": "subscription",
      "customerId": "<string>",
      "planId": "<string>",
      "name": "<string>",
      "status": "active",
      "createdAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "endingAt": "2023-11-07T05:31:56Z",
      "terminatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customerId
string

Unique identifier for a customer

​
consumerId
string

Unique identifier for an organization

​
merchantId
string

Unique identifier for an organization

​
status
enum<string>
Available options:
active,
terminated
​
limit
integer
default:10

Number of subscriptions to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of subscriptions to skip

Required range: x >= 0

Response

200
application/json
List of subscriptions

The response is of type object.