Distribute Term
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/bills/distribute-bills \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Distribute",
"action": "Distribute Bills",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"termID": 5,
"sheduleTime": "2026-06-15T10:00:00"
},
"billId": null
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/bills/distribute-bills"
payload = {
"method": "Distribute",
"action": "Distribute Bills",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"termID": 5,
"sheduleTime": "2026-06-15T10:00:00"
},
"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: 'Distribute',
action: 'Distribute Bills',
apiVersion: 'v2',
operation: 'schedule',
data: {termID: 5, sheduleTime: '2026-06-15T10:00:00'},
billId: null
})
};
fetch('https://{workspace}.spreesuite.com/billspree/bills/distribute-bills', 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/bills/distribute-bills",
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' => 'Distribute',
'action' => 'Distribute Bills',
'apiVersion' => 'v2',
'operation' => 'schedule',
'data' => [
'termID' => 5,
'sheduleTime' => '2026-06-15T10:00:00'
],
'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/bills/distribute-bills"
payload := strings.NewReader("{\n \"method\": \"Distribute\",\n \"action\": \"Distribute Bills\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n },\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/bills/distribute-bills")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Distribute\",\n \"action\": \"Distribute Bills\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n },\n \"billId\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/bills/distribute-bills")
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\": \"Distribute\",\n \"action\": \"Distribute Bills\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n },\n \"billId\": null\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"message": "<string>",
"statusCode": 123,
"error": null
}Bill Run
Distribute Term
Step 9 of the bill-run flow. Sends published bills to customers via the configured delivery channel (email, portal, etc.). Term must be in Published status before this step. Pass billId to distribute a single bill only.
POST
/
billspree
/
bills
/
distribute-bills
Distribute Term
curl --request POST \
--url https://{workspace}.spreesuite.com/billspree/bills/distribute-bills \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "Distribute",
"action": "Distribute Bills",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"termID": 5,
"sheduleTime": "2026-06-15T10:00:00"
},
"billId": null
}
'import requests
url = "https://{workspace}.spreesuite.com/billspree/bills/distribute-bills"
payload = {
"method": "Distribute",
"action": "Distribute Bills",
"apiVersion": "v2",
"operation": "schedule",
"data": {
"termID": 5,
"sheduleTime": "2026-06-15T10:00:00"
},
"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: 'Distribute',
action: 'Distribute Bills',
apiVersion: 'v2',
operation: 'schedule',
data: {termID: 5, sheduleTime: '2026-06-15T10:00:00'},
billId: null
})
};
fetch('https://{workspace}.spreesuite.com/billspree/bills/distribute-bills', 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/bills/distribute-bills",
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' => 'Distribute',
'action' => 'Distribute Bills',
'apiVersion' => 'v2',
'operation' => 'schedule',
'data' => [
'termID' => 5,
'sheduleTime' => '2026-06-15T10:00:00'
],
'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/bills/distribute-bills"
payload := strings.NewReader("{\n \"method\": \"Distribute\",\n \"action\": \"Distribute Bills\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n },\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/bills/distribute-bills")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"Distribute\",\n \"action\": \"Distribute Bills\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n },\n \"billId\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.spreesuite.com/billspree/bills/distribute-bills")
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\": \"Distribute\",\n \"action\": \"Distribute Bills\",\n \"apiVersion\": \"v2\",\n \"operation\": \"schedule\",\n \"data\": {\n \"termID\": 5,\n \"sheduleTime\": \"2026-06-15T10:00:00\"\n },\n \"billId\": null\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
Always "Distribute"
Example:
"Distribute"
Always "Distribute Bills"
Example:
"Distribute Bills"
Example:
"v2"
Always "schedule"
Example:
"schedule"
Show child attributes
Show child attributes
Pass to distribute a single bill only — null to distribute all bills in the term
Was this page helpful?
⌘I
