Endpoint: /Subscription/List

This endpoint will allow an API consumer to retrieve a list of their current subscriptions for a given x-scope. This will return any Customer subscriptions, and any patient or billing subscriptions that correlate to the passed x-scope.

Request: JSON

{
    "OnlyActiveSubscriptions": bool
}

Field	Data Type	Required	Comments
OnlyActiveSubscriptions	Boolean	Not Required	Boolean representing whether or not to return only "Subscribed" status or to return all subscriptions. Defaults to false.

Response: JSON

{
	"Metadata": {
        "ApiSender": string,
        "ApiConsumer": string,
        "MessageDateTime": DateTime
	},
    "Data": {
        "SubscriptionList": [
            {
                "SubscriptionType": string,
                "CallbackUrl": string,
                "SubscriptionStatus": string
            }
        ]
    }
}