Process Term
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/terms/process-term \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Update",
"action": "Process Term",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"termID": 5,
"sheduleTime": "2026-06-15T10:00:00"
}
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/terms/process-term"
payload = {
"method": "Update",
"action": "Process Term",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"termID": 5,
"sheduleTime": "2026-06-15T10:00:00"
}
}
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: 'Process Term',
apiVersion: 'v2',
operation: 'schedule',
data: {termID: 5, sheduleTime: '2026-06-15T10:00:00'}
})
};
fetch('https://{workspace}.spreesuite.com/billspree/terms/process-term', 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/process-term",
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' => 'Process Term',
'apiVersion' => 'v2',
'operation' => 'schedule',
'data' => [
'termID' => 5,
'sheduleTime' => '2026-06-15T10:00:00'
]
]),
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/process-term"
payload := strings.NewReader("{\n \"method\": \"Update\",\n \"action\": \"Process Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\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/terms/process-term")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Update\",\n \"action\": \"Process Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/terms/process-term")
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\": \"Process Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"message": "<string>",
"statusCode": 123,
"error": null
}Bill Run
Process Term
Step 6 of the bill-run flow. Runs billing calculations for all subscriptions in the term. Registered as an async job — pass the current time in sheduleTime to run immediately.
POST
/
billspree
/
terms
/
process-term
Process Term
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/terms/process-term \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Update",
"action": "Process Term",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"termID": 5,
"sheduleTime": "2026-06-15T10:00:00"
}
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/terms/process-term"
payload = {
"method": "Update",
"action": "Process Term",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"termID": 5,
"sheduleTime": "2026-06-15T10:00:00"
}
}
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: 'Process Term',
apiVersion: 'v2',
operation: 'schedule',
data: {termID: 5, sheduleTime: '2026-06-15T10:00:00'}
})
};
fetch('https://{workspace}.spreesuite.com/billspree/terms/process-term', 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/process-term",
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' => 'Process Term',
'apiVersion' => 'v2',
'operation' => 'schedule',
'data' => [
'termID' => 5,
'sheduleTime' => '2026-06-15T10:00:00'
]
]),
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/process-term"
payload := strings.NewReader("{\n \"method\": \"Update\",\n \"action\": \"Process Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\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/terms/process-term")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Update\",\n \"action\": \"Process Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/terms/process-term")
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\": \"Process Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"message": "<string>",
"statusCode": 123,
"error": null
}Authorizations
Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)
Body
application/json
Was this page helpful?
⌘I
