Skip to main content
POST
/
billspree
/
connections
/
get-connections
Get Subscriptions
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
}
'
{
  "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

​
Authorization
string
header
required

Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)

Body

application/json
​
method
string
required

Always "Retrieve"

Example:

"Retrieve"

​
action
string
required

Always "Retrieve Subscriptions"

Example:

"Retrieve Subscriptions"

​
apiVersion
string
required

Always "v2"

Example:

"v2"

​
serviceCode
string | null

Filter by pricing template code — null returns all

​
connectionNumber
string | null

Fetch a specific subscription by its number

​
partyID
integer | null

Filter by customer/party ID

​
subscriptionType
string | null

Filter by subscription type

​
status
string | null

Filter by status — e.g. "Active", "Disconnected"

​
filters
object | null

Additional data to include — e.g. { "bills": true, "payments": true }

​
metaData
object | null

Extra metadata options for the query

​
page
object | null

Pagination — e.g. { "pageNumber": 0, "size": 10 }. null returns all

Response

200 - application/json

Subscriptions retrieved successfully

​
success
boolean
​
statusCode
integer
​
message
string
​
error
unknown
​
data
object