Bureaucrats, editor
349
edits
Changes
Jump to navigation
Jump to search
no edit summary
Description=Returns the list of [[Subscription]] objects that belong to the user. This method can only be accessed with a valid logged token (not accessible by anonymous).
This method retrieves all the subscriptions applying some filters:* It automatically filters the results to return only subscription types Normal (1) and AllPlaylist (24) (see [[SubscriptionType]] enumeration). * It also filters out Subscriptions with [[SubscriptionPurchaseType]] = Provisioning Only, returning only Bottom Up and Both.(Except if applyProvisioningFilter is set to true)
}}
{{Api_Parameter|
ParamName=<span style="color:#7DC04E; ">bottomUpOnly </span>applyProvisioningFilter|ParamType=intbool
|ParamRequired=optional
|ParamDescription=<span style="'color:#7DC04E; "green'>Indicates if this method should return subscription of [[SubscriptionPurchaseType]] = Provisioning Only or not ((NEW IN 2.4)</span> false (default value): the method will return Subscriptions with Purchase Type in (Both, ApiOnly). true: the method will return Subscriptions with Purchase Type in (Both, ApiOnly, ProvisioningOnly).
}}
|Returns=
Returns a JSON object containing an array of [[Subscription]].
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}- valign="top"
! 2.4
{{!}} New parameter '''applyProvisioningFilter'''
{{!}} Ricardo Calvo
{{!}}- valign="top"
{{!}}}
|SeeAlso=
* [[SubscriptionTypesSubscriptionType]] enumeration
* [[SubscriptionPurchaseType]] enumeration
* [[Subscription]] object
* [[UNIAPI_Specification#Subscription Service|Subscription Service]] methods
}}
