Request

Parameter Length Possible Values Description

filters

--

filters

Defines filter conditions for querying data

attributes

--

Attributes

List of fields to be returned in the response

Filters

Parameter Length Data type Description

column


--

String

possible values are id,
vendorSubscriptionId,
endCustomer.name

operator


--

String

Possible Value is "="

value


--

String | Integer

Value to compare against the column

Attributes

Parameter Length Data type Description

attributes


--

String

possible values are id, vendorSubscriptionId, endCustomer, contract, items

Response

Parameter Length Data type Description

result


array

Result

List of subscription records matching the request filters and pagination criteria.

offset


--

Integer

Starting index of the records returned in the response. Used for pagination.

max

--

Integer

Maximum number of subscription records returned in a single response.

recordCount

--

Integer

Number of subscription records returned in the current response.

totalCount

--

Integer

Total number of subscription records available for the given filter criteria.

status

--

String

Status of the API response

info

--

String

Informational message providing additional details about the subscription.

Result

Parameter Length Data type Description

id


--

String

Unique identifier of the subscription.

distributor


--

String

Identifier or name of the distributor managing the subscription.

endCustomer


--

String

Unique identifier of the end customer associated with the subscription.

renewalConfig


--

Date

Date indicating when the subscription renewal configuration becomes effective.

showFraudEvents


--

Integer

Indicates whether fraud-related events are enabled for this subscription.

template


--

String

Identifier of the subscription template used to provision or manage the subscription.