Skip to main content
POST
/
billspree
/
connections
/
make-connections
Create Subscription
curl --request POST \
  --url https://{workspace}.spreesuite.com/billspree/connections/make-connections \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "Create",
  "action": "Create Subscription",
  "apiVersion": "v2",
  "batchUpload": false,
  "connection": {
    "serviceCode": "DEMO-001",
    "tariffCode": "DemoPlan",
    "batchCode": null,
    "addonTariffLabels": [],
    "connectionRefNo": null,
    "description": null,
    "postType": "Post Subscription",
    "paymentMethod": null,
    "projectName": null,
    "connectionInputs": [
      {
        "name": "MeterNo",
        "value": "12345"
      }
    ],
    "meteredConnectionInputs": [],
    "unmeteredInputs": [],
    "meters": [],
    "accounts": [],
    "users": [],
    "variants": [],
    "address": null
  }
}
'
{
  "success": true,
  "statusCode": 200,
  "message": "Request Succeeded.",
  "error": null,
  "data": {}
}

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 "Create"

Example:

"Create"

action
string
required

Always "Create Subscription"

Example:

"Create Subscription"

apiVersion
string
required

Always "v2"

Example:

"v2"

connection
object
required
batchUpload
boolean

false for single subscription creation

Example:

false

Response

200 - application/json

Subscription created successfully

success
boolean
statusCode
integer
message
string
error
unknown
data
object