Create Term

Step 1 of the bill-run flow. Creates a billing term (period) for a pricing template and batch. The termID returned from Get Terms is required for all subsequent steps.

POST /billspree/terms/make-term

Create Term

cURL

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"
  }
}
'

200

{
  "success": true,
  "statusCode": 200,
  "message": "Request Succeeded.",
  "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 "Create"

Example:

"Create"

action · string · required

Always "Create Bill Term"

Example:

"Create Bill Term"

apiVersion · string · required

Example:

"v2"

operation · string · required

Always "schedule"

Example:

"schedule"

data · object · required

Show child attributes

Response

200 - application/json

Term created successfully

success · boolean

statusCode · integer

message · string

error · unknown

data · object