Update Subscription
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/connections/update-connection \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Update",
"action": "Update Subscription",
"apiVersion": "v2",
"connection": {
"id": 1,
"connectionNumber": "CONN-001",
"tariffCode": "DemoPlan",
"batchCode": null,
"connRefNo": null,
"description": null,
"ts": 1,
"connectionDate": "01012026",
"paymentMethod": null,
"connectionInputs": [
{
"name": "MeterNo",
"value": "99999"
}
],
"meteredConnectionInputs": [],
"address": {
"city": "Karachi",
"street": "Main Blvd",
"countryId": null
},
"users": [],
"meters": [],
"accounts": [],
"variants": []
}
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/connections/update-connection"
payload = {
"method": "Update",
"action": "Update Subscription",
"apiVersion": "v2",
"connection": {
"id": 1,
"connectionNumber": "CONN-001",
"tariffCode": "DemoPlan",
"batchCode": None,
"connRefNo": None,
"description": None,
"ts": 1,
"connectionDate": "01012026",
"paymentMethod": None,
"connectionInputs": [
{
"name": "MeterNo",
"value": "99999"
}
],
"meteredConnectionInputs": [],
"address": {
"city": "Karachi",
"street": "Main Blvd",
"countryId": None
},
"users": [],
"meters": [],
"accounts": [],
"variants": []
}
}
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: 'Update',
action: 'Update Subscription',
apiVersion: 'v2',
connection: {
id: 1,
connectionNumber: 'CONN-001',
tariffCode: 'DemoPlan',
batchCode: null,
connRefNo: null,
description: null,
ts: 1,
connectionDate: '01012026',
paymentMethod: null,
connectionInputs: [{name: 'MeterNo', value: '99999'}],
meteredConnectionInputs: [],
address: {city: 'Karachi', street: 'Main Blvd', countryId: null},
users: [],
meters: [],
accounts: [],
variants: []
}
})
};
fetch('https://{workspace}.spreesuite.com/billspree/connections/update-connection', 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/update-connection",
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' => 'Update',
'action' => 'Update Subscription',
'apiVersion' => 'v2',
'connection' => [
'id' => 1,
'connectionNumber' => 'CONN-001',
'tariffCode' => 'DemoPlan',
'batchCode' => null,
'connRefNo' => null,
'description' => null,
'ts' => 1,
'connectionDate' => '01012026',
'paymentMethod' => null,
'connectionInputs' => [
[
'name' => 'MeterNo',
'value' => '99999'
]
],
'meteredConnectionInputs' => [
],
'address' => [
'city' => 'Karachi',
'street' => 'Main Blvd',
'countryId' => null
],
'users' => [
],
'meters' => [
],
'accounts' => [
],
'variants' => [
]
]
]),
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/update-connection"
payload := strings.NewReader("{\n \"method\": \"Update\",\n \"action\": \"Update Subscription\",\n \"apiVersion\": \"v2\",\n \"connection\": {\n \"id\": 1,\n \"connectionNumber\": \"CONN-001\",\n \"tariffCode\": \"DemoPlan\",\n \"batchCode\": null,\n \"connRefNo\": null,\n \"description\": null,\n \"ts\": 1,\n \"connectionDate\": \"01012026\",\n \"paymentMethod\": null,\n \"connectionInputs\": [\n {\n \"name\": \"MeterNo\",\n \"value\": \"99999\"\n }\n ],\n \"meteredConnectionInputs\": [],\n \"address\": {\n \"city\": \"Karachi\",\n \"street\": \"Main Blvd\",\n \"countryId\": null\n },\n \"users\": [],\n \"meters\": [],\n \"accounts\": [],\n \"variants\": []\n }\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/update-connection")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Update\",\n \"action\": \"Update Subscription\",\n \"apiVersion\": \"v2\",\n \"connection\": {\n \"id\": 1,\n \"connectionNumber\": \"CONN-001\",\n \"tariffCode\": \"DemoPlan\",\n \"batchCode\": null,\n \"connRefNo\": null,\n \"description\": null,\n \"ts\": 1,\n \"connectionDate\": \"01012026\",\n \"paymentMethod\": null,\n \"connectionInputs\": [\n {\n \"name\": \"MeterNo\",\n \"value\": \"99999\"\n }\n ],\n \"meteredConnectionInputs\": [],\n \"address\": {\n \"city\": \"Karachi\",\n \"street\": \"Main Blvd\",\n \"countryId\": null\n },\n \"users\": [],\n \"meters\": [],\n \"accounts\": [],\n \"variants\": []\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/connections/update-connection")
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\": \"Update\",\n \"action\": \"Update Subscription\",\n \"apiVersion\": \"v2\",\n \"connection\": {\n \"id\": 1,\n \"connectionNumber\": \"CONN-001\",\n \"tariffCode\": \"DemoPlan\",\n \"batchCode\": null,\n \"connRefNo\": null,\n \"description\": null,\n \"ts\": 1,\n \"connectionDate\": \"01012026\",\n \"paymentMethod\": null,\n \"connectionInputs\": [\n {\n \"name\": \"MeterNo\",\n \"value\": \"99999\"\n }\n ],\n \"meteredConnectionInputs\": [],\n \"address\": {\n \"city\": \"Karachi\",\n \"street\": \"Main Blvd\",\n \"countryId\": null\n },\n \"users\": [],\n \"meters\": [],\n \"accounts\": [],\n \"variants\": []\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {}
}Subscriptions
Update Subscription
Update an existing subscription. Always read ts from the GET response before updating — the backend rejects stale updates. serviceCode cannot be changed. Subscriptions with status: "Disconnected" cannot be updated.
POST
/
billspree
/
connections
/
update-connection
Update Subscription
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/connections/update-connection \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Update",
"action": "Update Subscription",
"apiVersion": "v2",
"connection": {
"id": 1,
"connectionNumber": "CONN-001",
"tariffCode": "DemoPlan",
"batchCode": null,
"connRefNo": null,
"description": null,
"ts": 1,
"connectionDate": "01012026",
"paymentMethod": null,
"connectionInputs": [
{
"name": "MeterNo",
"value": "99999"
}
],
"meteredConnectionInputs": [],
"address": {
"city": "Karachi",
"street": "Main Blvd",
"countryId": null
},
"users": [],
"meters": [],
"accounts": [],
"variants": []
}
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/connections/update-connection"
payload = {
"method": "Update",
"action": "Update Subscription",
"apiVersion": "v2",
"connection": {
"id": 1,
"connectionNumber": "CONN-001",
"tariffCode": "DemoPlan",
"batchCode": None,
"connRefNo": None,
"description": None,
"ts": 1,
"connectionDate": "01012026",
"paymentMethod": None,
"connectionInputs": [
{
"name": "MeterNo",
"value": "99999"
}
],
"meteredConnectionInputs": [],
"address": {
"city": "Karachi",
"street": "Main Blvd",
"countryId": None
},
"users": [],
"meters": [],
"accounts": [],
"variants": []
}
}
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: 'Update',
action: 'Update Subscription',
apiVersion: 'v2',
connection: {
id: 1,
connectionNumber: 'CONN-001',
tariffCode: 'DemoPlan',
batchCode: null,
connRefNo: null,
description: null,
ts: 1,
connectionDate: '01012026',
paymentMethod: null,
connectionInputs: [{name: 'MeterNo', value: '99999'}],
meteredConnectionInputs: [],
address: {city: 'Karachi', street: 'Main Blvd', countryId: null},
users: [],
meters: [],
accounts: [],
variants: []
}
})
};
fetch('https://{workspace}.spreesuite.com/billspree/connections/update-connection', 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/update-connection",
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' => 'Update',
'action' => 'Update Subscription',
'apiVersion' => 'v2',
'connection' => [
'id' => 1,
'connectionNumber' => 'CONN-001',
'tariffCode' => 'DemoPlan',
'batchCode' => null,
'connRefNo' => null,
'description' => null,
'ts' => 1,
'connectionDate' => '01012026',
'paymentMethod' => null,
'connectionInputs' => [
[
'name' => 'MeterNo',
'value' => '99999'
]
],
'meteredConnectionInputs' => [
],
'address' => [
'city' => 'Karachi',
'street' => 'Main Blvd',
'countryId' => null
],
'users' => [
],
'meters' => [
],
'accounts' => [
],
'variants' => [
]
]
]),
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/update-connection"
payload := strings.NewReader("{\n \"method\": \"Update\",\n \"action\": \"Update Subscription\",\n \"apiVersion\": \"v2\",\n \"connection\": {\n \"id\": 1,\n \"connectionNumber\": \"CONN-001\",\n \"tariffCode\": \"DemoPlan\",\n \"batchCode\": null,\n \"connRefNo\": null,\n \"description\": null,\n \"ts\": 1,\n \"connectionDate\": \"01012026\",\n \"paymentMethod\": null,\n \"connectionInputs\": [\n {\n \"name\": \"MeterNo\",\n \"value\": \"99999\"\n }\n ],\n \"meteredConnectionInputs\": [],\n \"address\": {\n \"city\": \"Karachi\",\n \"street\": \"Main Blvd\",\n \"countryId\": null\n },\n \"users\": [],\n \"meters\": [],\n \"accounts\": [],\n \"variants\": []\n }\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/update-connection")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Update\",\n \"action\": \"Update Subscription\",\n \"apiVersion\": \"v2\",\n \"connection\": {\n \"id\": 1,\n \"connectionNumber\": \"CONN-001\",\n \"tariffCode\": \"DemoPlan\",\n \"batchCode\": null,\n \"connRefNo\": null,\n \"description\": null,\n \"ts\": 1,\n \"connectionDate\": \"01012026\",\n \"paymentMethod\": null,\n \"connectionInputs\": [\n {\n \"name\": \"MeterNo\",\n \"value\": \"99999\"\n }\n ],\n \"meteredConnectionInputs\": [],\n \"address\": {\n \"city\": \"Karachi\",\n \"street\": \"Main Blvd\",\n \"countryId\": null\n },\n \"users\": [],\n \"meters\": [],\n \"accounts\": [],\n \"variants\": []\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/connections/update-connection")
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\": \"Update\",\n \"action\": \"Update Subscription\",\n \"apiVersion\": \"v2\",\n \"connection\": {\n \"id\": 1,\n \"connectionNumber\": \"CONN-001\",\n \"tariffCode\": \"DemoPlan\",\n \"batchCode\": null,\n \"connRefNo\": null,\n \"description\": null,\n \"ts\": 1,\n \"connectionDate\": \"01012026\",\n \"paymentMethod\": null,\n \"connectionInputs\": [\n {\n \"name\": \"MeterNo\",\n \"value\": \"99999\"\n }\n ],\n \"meteredConnectionInputs\": [],\n \"address\": {\n \"city\": \"Karachi\",\n \"street\": \"Main Blvd\",\n \"countryId\": null\n },\n \"users\": [],\n \"meters\": [],\n \"accounts\": [],\n \"variants\": []\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {}
}Authorizations
Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)
Body
application/json
Was this page helpful?
⌘I
