Skip to main content
POST
Get Pricing Modules

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 context 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