Skip to main content
POST
/
billspree
/
tariffs
/
get-tariffs
Get Pricing Modules
curl --request POST \
  --url https://{workspace}.spreesuite.com/billspree/tariffs/get-tariffs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "Retrieve",
  "action": "Retrieve Plans",
  "apiVersion": "v2",
  "serviceCode": null,
  "tariffID": null,
  "exceptSubtree": null
}
'
{
  "success": true,
  "statusCode": 200,
  "message": "Request Succeeded.",
  "error": null,
  "data": {
    "tariffs": [
      {
        "tariffID": 1,
        "tariffCode": "DemoPlan",
        "uniqueLabel": "DemoPlan",
        "label": "Demo Plan",
        "description": null,
        "serviceCode": "DEMO-001",
        "parentTariffCode": null,
        "securityAttributes": [],
        "connCount": 1
      }
    ]
  }
}

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 Plans"

Example:

"Retrieve Plans"

​
apiVersion
string
required

Always "v2"

Example:

"v2"

​
serviceCode
string | null

Filter by pricing template code — null returns all plans across all templates

​
tariffID
integer | null

Fetch a specific plan by its ID

​
exceptSubtree
integer | null

Exclude a plan and all its descendants — used when selecting a parent plan to avoid circular references

Response

200 - application/json

Plans retrieved successfully

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