Create Term
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/terms/make-term \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Create",
"action": "Create Bill Term",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"serviceCode": "DEMO-001",
"batchCode": "BATCH-001",
"billingPeriodID": 1,
"label": "JUNE2026",
"startDate": "01/06/2026",
"endDate": "30/06/2026",
"dueDate": "10/07/2026",
"postType": "Post Subscription"
}
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/terms/make-term"
payload = {
"method": "Create",
"action": "Create Bill Term",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"serviceCode": "DEMO-001",
"batchCode": "BATCH-001",
"billingPeriodID": 1,
"label": "JUNE2026",
"startDate": "01/06/2026",
"endDate": "30/06/2026",
"dueDate": "10/07/2026",
"postType": "Post Subscription"
}
}
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: 'Create',
action: 'Create Bill Term',
apiVersion: 'v2',
operation: 'schedule',
data: {
serviceCode: 'DEMO-001',
batchCode: 'BATCH-001',
billingPeriodID: 1,
label: 'JUNE2026',
startDate: '01/06/2026',
endDate: '30/06/2026',
dueDate: '10/07/2026',
postType: 'Post Subscription'
}
})
};
fetch('https://{workspace}.spreesuite.com/billspree/terms/make-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/make-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' => 'Create',
'action' => 'Create Bill Term',
'apiVersion' => 'v2',
'operation' => 'schedule',
'data' => [
'serviceCode' => 'DEMO-001',
'batchCode' => 'BATCH-001',
'billingPeriodID' => 1,
'label' => 'JUNE2026',
'startDate' => '01/06/2026',
'endDate' => '30/06/2026',
'dueDate' => '10/07/2026',
'postType' => 'Post Subscription'
]
]),
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/make-term"
payload := strings.NewReader("{\n \"method\": \"Create\",\n \"action\": \"Create Bill Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"serviceCode\": \"DEMO-001\",\n \"batchCode\": \"BATCH-001\",\n \"billingPeriodID\": 1,\n \"label\": \"JUNE2026\",\n \"startDate\": \"01/06/2026\",\n \"endDate\": \"30/06/2026\",\n \"dueDate\": \"10/07/2026\",\n \"postType\": \"Post Subscription\"\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/make-term")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Create\",\n \"action\": \"Create Bill Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"serviceCode\": \"DEMO-001\",\n \"batchCode\": \"BATCH-001\",\n \"billingPeriodID\": 1,\n \"label\": \"JUNE2026\",\n \"startDate\": \"01/06/2026\",\n \"endDate\": \"30/06/2026\",\n \"dueDate\": \"10/07/2026\",\n \"postType\": \"Post Subscription\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/terms/make-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\": \"Create\",\n \"action\": \"Create Bill Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"serviceCode\": \"DEMO-001\",\n \"batchCode\": \"BATCH-001\",\n \"billingPeriodID\": 1,\n \"label\": \"JUNE2026\",\n \"startDate\": \"01/06/2026\",\n \"endDate\": \"30/06/2026\",\n \"dueDate\": \"10/07/2026\",\n \"postType\": \"Post Subscription\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Request Succeeded.",
"error": null,
"data": {}
}Bill Run
Create Term
Step 1 of the bill-run flow. Creates a billing term (period) for a pricing context and batch. The termID returned from Get Terms is required for all subsequent steps.
POST
/
billspree
/
terms
/
make-term
Create Term
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/terms/make-term \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Create",
"action": "Create Bill Term",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"serviceCode": "DEMO-001",
"batchCode": "BATCH-001",
"billingPeriodID": 1,
"label": "JUNE2026",
"startDate": "01/06/2026",
"endDate": "30/06/2026",
"dueDate": "10/07/2026",
"postType": "Post Subscription"
}
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/terms/make-term"
payload = {
"method": "Create",
"action": "Create Bill Term",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"serviceCode": "DEMO-001",
"batchCode": "BATCH-001",
"billingPeriodID": 1,
"label": "JUNE2026",
"startDate": "01/06/2026",
"endDate": "30/06/2026",
"dueDate": "10/07/2026",
"postType": "Post Subscription"
}
}
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: 'Create',
action: 'Create Bill Term',
apiVersion: 'v2',
operation: 'schedule',
data: {
serviceCode: 'DEMO-001',
batchCode: 'BATCH-001',
billingPeriodID: 1,
label: 'JUNE2026',
startDate: '01/06/2026',
endDate: '30/06/2026',
dueDate: '10/07/2026',
postType: 'Post Subscription'
}
})
};
fetch('https://{workspace}.spreesuite.com/billspree/terms/make-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/make-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' => 'Create',
'action' => 'Create Bill Term',
'apiVersion' => 'v2',
'operation' => 'schedule',
'data' => [
'serviceCode' => 'DEMO-001',
'batchCode' => 'BATCH-001',
'billingPeriodID' => 1,
'label' => 'JUNE2026',
'startDate' => '01/06/2026',
'endDate' => '30/06/2026',
'dueDate' => '10/07/2026',
'postType' => 'Post Subscription'
]
]),
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/make-term"
payload := strings.NewReader("{\n \"method\": \"Create\",\n \"action\": \"Create Bill Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"serviceCode\": \"DEMO-001\",\n \"batchCode\": \"BATCH-001\",\n \"billingPeriodID\": 1,\n \"label\": \"JUNE2026\",\n \"startDate\": \"01/06/2026\",\n \"endDate\": \"30/06/2026\",\n \"dueDate\": \"10/07/2026\",\n \"postType\": \"Post Subscription\"\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/make-term")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Create\",\n \"action\": \"Create Bill Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"serviceCode\": \"DEMO-001\",\n \"batchCode\": \"BATCH-001\",\n \"billingPeriodID\": 1,\n \"label\": \"JUNE2026\",\n \"startDate\": \"01/06/2026\",\n \"endDate\": \"30/06/2026\",\n \"dueDate\": \"10/07/2026\",\n \"postType\": \"Post Subscription\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/terms/make-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\": \"Create\",\n \"action\": \"Create Bill Term\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"serviceCode\": \"DEMO-001\",\n \"batchCode\": \"BATCH-001\",\n \"billingPeriodID\": 1,\n \"label\": \"JUNE2026\",\n \"startDate\": \"01/06/2026\",\n \"endDate\": \"30/06/2026\",\n \"dueDate\": \"10/07/2026\",\n \"postType\": \"Post Subscription\"\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
