Get Terms
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/terms/get-terms \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Retrieve",
"action": "Retrieve Terms",
"apiVersion": "v2",
"serviceCode": "DEMO-001",
"termID": null,
"page": null,
"filters": null,
"metaData": null,
"type": null,
"status": null,
"billID": null
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/terms/get-terms"
payload = {
"method": "Retrieve",
"action": "Retrieve Terms",
"apiVersion": "v2",
"serviceCode": "DEMO-001",
"termID": None,
"page": None,
"filters": None,
"metaData": None,
"type": None,
"status": None,
"billID": 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 Terms',
apiVersion: 'v2',
serviceCode: 'DEMO-001',
termID: null,
page: null,
filters: null,
metaData: null,
type: null,
status: null,
billID: null
})
};
fetch('https://{workspace}.spreesuite.com/billspree/terms/get-terms', 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/terms/get-terms",
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 Terms',
'apiVersion' => 'v2',
'serviceCode' => 'DEMO-001',
'termID' => null,
'page' => null,
'filters' => null,
'metaData' => null,
'type' => null,
'status' => null,
'billID' => 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/terms/get-terms"
payload := strings.NewReader("{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Terms\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"termID\": null,\n \"page\": null,\n \"filters\": null,\n \"metaData\": null,\n \"type\": null,\n \"status\": null,\n \"billID\": 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/terms/get-terms")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Terms\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"termID\": null,\n \"page\": null,\n \"filters\": null,\n \"metaData\": null,\n \"type\": null,\n \"status\": null,\n \"billID\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/terms/get-terms")
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 Terms\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"termID\": null,\n \"page\": null,\n \"filters\": null,\n \"metaData\": null,\n \"type\": null,\n \"status\": null,\n \"billID\": null\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {
"terms": [
{
"termID": 5,
"label": "JUNE2026",
"startDate": "01/06/2026",
"endDate": "30/06/2026",
"dueDate": "10/07/2026",
"status": "Open",
"serviceCode": "DEMO-001",
"batchCode": "BATCH-001"
}
]
}
}Bill Run
Get Terms
Step 2 of the bill-run flow (and after any step to check status). Retrieve billing terms with optional filtering. The termID from this response is required for all subsequent bill-run steps.
POST
/
billspree
/
terms
/
get-terms
Get Terms
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/terms/get-terms \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Retrieve",
"action": "Retrieve Terms",
"apiVersion": "v2",
"serviceCode": "DEMO-001",
"termID": null,
"page": null,
"filters": null,
"metaData": null,
"type": null,
"status": null,
"billID": null
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/terms/get-terms"
payload = {
"method": "Retrieve",
"action": "Retrieve Terms",
"apiVersion": "v2",
"serviceCode": "DEMO-001",
"termID": None,
"page": None,
"filters": None,
"metaData": None,
"type": None,
"status": None,
"billID": 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 Terms',
apiVersion: 'v2',
serviceCode: 'DEMO-001',
termID: null,
page: null,
filters: null,
metaData: null,
type: null,
status: null,
billID: null
})
};
fetch('https://{workspace}.spreesuite.com/billspree/terms/get-terms', 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/terms/get-terms",
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 Terms',
'apiVersion' => 'v2',
'serviceCode' => 'DEMO-001',
'termID' => null,
'page' => null,
'filters' => null,
'metaData' => null,
'type' => null,
'status' => null,
'billID' => 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/terms/get-terms"
payload := strings.NewReader("{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Terms\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"termID\": null,\n \"page\": null,\n \"filters\": null,\n \"metaData\": null,\n \"type\": null,\n \"status\": null,\n \"billID\": 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/terms/get-terms")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Retrieve\",\n \"action\": \"Retrieve Terms\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"termID\": null,\n \"page\": null,\n \"filters\": null,\n \"metaData\": null,\n \"type\": null,\n \"status\": null,\n \"billID\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/terms/get-terms")
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 Terms\",\n \"apiVersion\": \"v2\",\n \"serviceCode\": \"DEMO-001\",\n \"termID\": null,\n \"page\": null,\n \"filters\": null,\n \"metaData\": null,\n \"type\": null,\n \"status\": null,\n \"billID\": null\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {
"terms": [
{
"termID": 5,
"label": "JUNE2026",
"startDate": "01/06/2026",
"endDate": "30/06/2026",
"dueDate": "10/07/2026",
"status": "Open",
"serviceCode": "DEMO-001",
"batchCode": "BATCH-001"
}
]
}
}Authorizations
Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)
Body
application/json
Always "Retrieve"
Example:
"Retrieve"
Always "Retrieve Terms"
Example:
"Retrieve Terms"
Example:
"v2"
Filter by pricing context — null returns all
Filter by specific term ID
Filter by term status — e.g. "Open", "Posted", "Published"
{ "pageNumber": 0, "size": 10 } — null returns all
Was this page helpful?
⌘I
