Skip to main content
POST
Get Subscriptions

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

Example:

"Retrieve Subscriptions"

apiVersion
string
required

Always "v2"

Example:

"v2"

serviceCode
string | null

Filter by pricing context code — null returns all

connectionNumber
string | null

Fetch a specific subscription by its number

partyID
integer | null

Filter by customer/party ID

subscriptionType
string | null

Filter by subscription type

status
string | null

Filter by status — e.g. "Active", "Disconnected"

filters
object | null

Additional data to include — e.g. { "bills": true, "payments": true }

metaData
object | null

Extra metadata options for the query

page
object | null

Pagination — e.g. { "pageNumber": 0, "size": 10 }. null returns all

Response

200 - application/json

Subscriptions retrieved successfully

success
boolean
statusCode
integer
message
string
error
unknown
data
object