Skip to main content
GET
/
api
/
v1
/
subscriptions
List subscriptions
curl --request GET \
  --url https://your-site.example/api/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://your-site.example/api/v1/subscriptions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://your-site.example/api/v1/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://your-site.example/api/v1/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://your-site.example/api/v1/subscriptions"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://your-site.example/api/v1/subscriptions")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://your-site.example/api/v1/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "33333333-3333-4333-8333-333333333333",
      "name": "Netflix",
      "category": "Streaming",
      "amount": 15.99,
      "currency": "USD",
      "period": "monthly",
      "lastPaymentDate": "2026-06-01",
      "nextPaymentDate": "2026-07-01",
      "notificationEnabled": true,
      "status": "active",
      "createdAt": "2026-06-16T00:00:00.000Z",
      "updatedAt": "2026-06-16T00:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "hasMore": false
  },
  "query": {
    "sort": "-createdAt",
    "filters": {}
  },
  "requestId": "request-1"
}

Authorizations

Authorization
string
header
default:subm_your_key_here
required

Developer API key generated in the app. Keys carry scopes; a read key can call list, get, analytics, and audit endpoints, while a write key additionally allows create, update, cancel, pause, resume, and delete.

Query Parameters

limit
integer
default:50

Maximum number of subscriptions to return (1-100, default 50).

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

Number of subscriptions to skip from the start of the list (default 0).

Required range: x >= 0
status
enum<string>

Filter by lifecycle state. Lifecycle state. active means billing; paused means temporarily stopped; cancelled means no longer billing but kept for history.

Available options:
active,
paused,
cancelled
category
string

Exact category match, for example "Streaming".

period
enum<string>

Filter by billing period. Billing cadence used to calculate nextPaymentDate.

Available options:
monthly,
yearly,
custom
q
string

Case-insensitive search over the subscription name.

expiringBefore
string

Return subscriptions whose nextPaymentDate is on or before this date. Combine with status=active to find renewals due soon. Calendar date without time, always in YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-06-01"

sort
enum<string>
default:-createdAt

Sort order; prefix with - for descending, for example -nextPaymentDate.

Available options:
createdAt,
-createdAt,
nextPaymentDate,
-nextPaymentDate,
amount,
-amount,
name,
-name

Response

Subscriptions returned.

data
object[]
required
pagination
object
required
requestId
string
required
query
object

Echo of the sort and filters applied to this response.