Skip to main content
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
}
'
{
  "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

​
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 "Retrieve"

Example:

"Retrieve"

​
action
string
required

Always "Retrieve Terms"

Example:

"Retrieve Terms"

​
apiVersion
string
required
Example:

"v2"

​
serviceCode
string | null

Filter by pricing template — null returns all

​
termID
integer | null

Filter by specific term ID

​
status
string | null

Filter by term status — e.g. "Open", "Posted", "Published"

​
filters
object | null
​
metaData
object | null
​
type
string | null
​
billID
integer | null
​
page
object | null

{ "pageNumber": 0, "size": 10 } — null returns all

Response

200 - application/json

Terms retrieved successfully

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