Skip to main content
POST
/
billspree
/
terms
/
publish-term
Publish Term
curl --request POST \
  --url https://{workspace}.spreesuite.com/billspree/terms/publish-term \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "Update",
  "action": "Publish Term",
  "apiVersion": "v2",
  "operation": "schedule",
  "data": {
    "termID": 5,
    "template_id": 12,
    "output_format": "pdf",
    "billType": "Batch billing",
    "sheduleTime": "2026-06-15T10:00:00"
  },
  "billID": null
}
'
{
  "success": true,
  "statusCode": 123,
  "message": "<string>",
  "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 "Update"

Example:

"Update"

​
action
string
required

Always "Publish Term"

Example:

"Publish Term"

​
apiVersion
string
required
Example:

"v2"

​
operation
string
required

Always "schedule"

Example:

"schedule"

​
data
object
required
​
billID
integer | null

Pass a specific bill ID to publish a single bill only — null to publish all bills in the term

Response

200 - application/json

Publish job registered

​
success
boolean
​
statusCode
integer
​
message
string
​
error
unknown
​
data
object