curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/connections/get-connections \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Retrieve",
"action": "Retrieve Subscriptions",
"apiVersion": "v2",
"serviceCode": "DEMO-001",
"connectionNumber": null,
"partyID": null,
"subscriptionType": null,
"status": null,
"filters": null,
"metaData": null,
"page": null
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/connections/get-connections"
payload = {
"method": "Retrieve",
"action": "Retrieve Subscriptions",
"apiVersion": "v2",
"serviceCode": "DEMO-001",
"connectionNumber": None,
"partyID": None,
"subscriptionType": None,
"status": None,
"filters": None,
"metaData": None,
"page": None
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'Retrieve',
action: 'Retrieve Subscriptions',
apiVersion: 'v2',
serviceCode: 'DEMO-001',
connectionNumber: null,
partyID: null,
subscriptionType: null,
status: null,
filters: null,
metaData: null,
page: null
})
};
fetch('https://{workspace}.spreesuite.com/billspree/connections/get-connections', 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://{workspace}.spreesuite.com/billspree/connections/get-connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'Retrieve',
'action' => 'Retrieve Subscriptions',
'apiVersion' => 'v2',
'serviceCode' => 'DEMO-001',
'connectionNumber' => null,
'partyID' => null,
'subscriptionType' => null,
'status' => null,
'filters' => null,
'metaData' => null,
'page' => null
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{workspace}.spreesuite.com/billspree/connections/get-connections"
payload := strings.NewReader("{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Subscriptions\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"connectionNumber\": null,\n \"partyID\": null,\n \"subscriptionType\": null,\n \"status\": null,\n \"filters\": null,\n \"metaData\": null,\n \"page\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{workspace}.spreesuite.com/billspree/connections/get-connections")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Subscriptions\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"connectionNumber\": null,\n \"partyID\": null,\n \"subscriptionType\": null,\n \"status\": null,\n \"filters\": null,\n \"metaData\": null,\n \"page\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/connections/get-connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Subscriptions\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"connectionNumber\": null,\n \"partyID\": null,\n \"subscriptionType\": null,\n \"status\": null,\n \"filters\": null,\n \"metaData\": null,\n \"page\": null\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {
"connections": [
{
"id": 1,
"connectionNumber": "CONN-001",
"connectionRefNo": "REF-001",
"serviceCode": "DEMO-001",
"tariffCode": "DemoPlan",
"batchCode": null,
"status": "Active",
"chargingType": "Postpaid",
"postType": "Post Subscription",
"connectionDate": "01012026",
"description": null,
"paymentMethod": null,
"ts": 1,
"partyID": 5,
"partyName": "John Doe",
"connectionInputs": [
{
"name": "MeterNo",
"value": "12345"
}
],
"meteredConnectionInputs": [],
"unmeteredInputs": [],
"meters": [],
"accounts": [
{
"title": "Monthly Charge",
"balance": 0
}
],
"address": {
"title": null,
"shopNo": null,
"buildingNo": null,
"buildingName": null,
"street": null,
"block": null,
"society": null,
"city": null,
"countryId": null
},
"users": [],
"addOns": [],
"variants": [],
"bills": [],
"transfers": []
}
]
}
}Get Subscriptions
Retrieve subscriptions with optional filtering by template, customer, status, or subscription number. Pass filters.bills: true or filters.payments: true to include related billing and payment data in the response.
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/connections/get-connections \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Retrieve",
"action": "Retrieve Subscriptions",
"apiVersion": "v2",
"serviceCode": "DEMO-001",
"connectionNumber": null,
"partyID": null,
"subscriptionType": null,
"status": null,
"filters": null,
"metaData": null,
"page": null
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/connections/get-connections"
payload = {
"method": "Retrieve",
"action": "Retrieve Subscriptions",
"apiVersion": "v2",
"serviceCode": "DEMO-001",
"connectionNumber": None,
"partyID": None,
"subscriptionType": None,
"status": None,
"filters": None,
"metaData": None,
"page": None
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'Retrieve',
action: 'Retrieve Subscriptions',
apiVersion: 'v2',
serviceCode: 'DEMO-001',
connectionNumber: null,
partyID: null,
subscriptionType: null,
status: null,
filters: null,
metaData: null,
page: null
})
};
fetch('https://{workspace}.spreesuite.com/billspree/connections/get-connections', 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://{workspace}.spreesuite.com/billspree/connections/get-connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'Retrieve',
'action' => 'Retrieve Subscriptions',
'apiVersion' => 'v2',
'serviceCode' => 'DEMO-001',
'connectionNumber' => null,
'partyID' => null,
'subscriptionType' => null,
'status' => null,
'filters' => null,
'metaData' => null,
'page' => null
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{workspace}.spreesuite.com/billspree/connections/get-connections"
payload := strings.NewReader("{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Subscriptions\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"connectionNumber\": null,\n \"partyID\": null,\n \"subscriptionType\": null,\n \"status\": null,\n \"filters\": null,\n \"metaData\": null,\n \"page\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{workspace}.spreesuite.com/billspree/connections/get-connections")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Subscriptions\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"connectionNumber\": null,\n \"partyID\": null,\n \"subscriptionType\": null,\n \"status\": null,\n \"filters\": null,\n \"metaData\": null,\n \"page\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/connections/get-connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Subscriptions\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"connectionNumber\": null,\n \"partyID\": null,\n \"subscriptionType\": null,\n \"status\": null,\n \"filters\": null,\n \"metaData\": null,\n \"page\": null\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {
"connections": [
{
"id": 1,
"connectionNumber": "CONN-001",
"connectionRefNo": "REF-001",
"serviceCode": "DEMO-001",
"tariffCode": "DemoPlan",
"batchCode": null,
"status": "Active",
"chargingType": "Postpaid",
"postType": "Post Subscription",
"connectionDate": "01012026",
"description": null,
"paymentMethod": null,
"ts": 1,
"partyID": 5,
"partyName": "John Doe",
"connectionInputs": [
{
"name": "MeterNo",
"value": "12345"
}
],
"meteredConnectionInputs": [],
"unmeteredInputs": [],
"meters": [],
"accounts": [
{
"title": "Monthly Charge",
"balance": 0
}
],
"address": {
"title": null,
"shopNo": null,
"buildingNo": null,
"buildingName": null,
"street": null,
"block": null,
"society": null,
"city": null,
"countryId": null
},
"users": [],
"addOns": [],
"variants": [],
"bills": [],
"transfers": []
}
]
}
}Authorizations
Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)
Body
Always "Retrieve"
"Retrieve"
Always "Retrieve Subscriptions"
"Retrieve Subscriptions"
Always "v2"
"v2"
Filter by pricing context code — null returns all
Fetch a specific subscription by its number
Filter by customer/party ID
Filter by subscription type
Filter by status — e.g. "Active", "Disconnected"
Additional data to include — e.g. { "bills": true, "payments": true }
Extra metadata options for the query
Pagination — e.g. { "pageNumber": 0, "size": 10 }. null returns all
Was this page helpful?
