List Subscriptions
curl --request GET \
--url https://sandboxapi.kelviq.com/api/v1/subscriptions/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandboxapi.kelviq.com/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://sandboxapi.kelviq.com/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://sandboxapi.kelviq.com/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://sandboxapi.kelviq.com/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://sandboxapi.kelviq.com/api/v1/subscriptions/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.kelviq.com/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{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "09d706ca-58f3-4fb2-818f-5b8623d67e6e",
"externalSubscriptionId": "sub_1RpoZoSBstCzyocS7iPmith3",
"startDate": "2025-07-28",
"endDate": null,
"billingPeriodStartTime": "2025-07-28T10:46:34Z",
"billingPeriodEndTime": "2025-08-28T10:46:34Z",
"amount": "261.00",
"recurrence": "month",
"currency": "usd",
"status": "active",
"product": "Aphelo",
"plan": {
"name": "Premium",
"identifier": "premium1"
},
"features": [
{
"id": "b417ae2f-35e2-48f2-a5c4-fdaa99b2b96a",
"identifier": "products",
"name": "Products",
"description": "",
"featureType": "CUSTOMIZABLE",
"details": {},
"isArchived": false,
"metadata": {},
"modifiedOn": "2025-06-14T11:36:26.062491Z",
"meter": {},
"featureDetails": {
"units": {
"plural": "counts",
"singular": "count"
}
},
"reset": null,
"resetTime": null,
"value": 100,
"hardLimit": false
}
],
"trialDaysRemaining": 0,
"customerId": "testuser",
"billingType": "SUBSCRIPTION",
"recurrenceUnit": 1,
"recurrenceType": "MONTH"
}
]
}Subscriptions
List Subscriptions
Retrieves a paginated list of subscriptions. You can filter the results by customer.
GET
/
subscriptions
/
List Subscriptions
curl --request GET \
--url https://sandboxapi.kelviq.com/api/v1/subscriptions/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandboxapi.kelviq.com/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://sandboxapi.kelviq.com/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://sandboxapi.kelviq.com/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://sandboxapi.kelviq.com/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://sandboxapi.kelviq.com/api/v1/subscriptions/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.kelviq.com/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{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "09d706ca-58f3-4fb2-818f-5b8623d67e6e",
"externalSubscriptionId": "sub_1RpoZoSBstCzyocS7iPmith3",
"startDate": "2025-07-28",
"endDate": null,
"billingPeriodStartTime": "2025-07-28T10:46:34Z",
"billingPeriodEndTime": "2025-08-28T10:46:34Z",
"amount": "261.00",
"recurrence": "month",
"currency": "usd",
"status": "active",
"product": "Aphelo",
"plan": {
"name": "Premium",
"identifier": "premium1"
},
"features": [
{
"id": "b417ae2f-35e2-48f2-a5c4-fdaa99b2b96a",
"identifier": "products",
"name": "Products",
"description": "",
"featureType": "CUSTOMIZABLE",
"details": {},
"isArchived": false,
"metadata": {},
"modifiedOn": "2025-06-14T11:36:26.062491Z",
"meter": {},
"featureDetails": {
"units": {
"plural": "counts",
"singular": "count"
}
},
"reset": null,
"resetTime": null,
"value": 100,
"hardLimit": false
}
],
"trialDaysRemaining": 0,
"customerId": "testuser",
"billingType": "SUBSCRIPTION",
"recurrenceUnit": 1,
"recurrenceType": "MONTH"
}
]
}Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.
Authorizations
The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'
Query Parameters
The client-defined unique identifier for the customer to filter subscriptions.
Number of results to return per page.
The initial index from which to return the results.
⌘I