From 9b7bf126205da00d44280f6e11748d86d299a55c Mon Sep 17 00:00:00 2001 From: Winston Weinert Date: Wed, 9 Jul 2014 15:07:09 -0500 Subject: Document user.canSubscribe --- json/authentication.rst | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/json/authentication.rst b/json/authentication.rst index 67f5879..4f1d1e4 100644 --- a/json/authentication.rst +++ b/json/authentication.rst @@ -177,3 +177,36 @@ The returned userAuthToken is used to authenticate access to other API methods. 1002,Wrong user credentials. + +.. _user-canSubscribe: + +Get user subscriber status +-------------------------- + +:Method: user.canSubscribe + +Returns whether a user is subscribed or if they can subscribe to Pandora One. +Can be useful to determine which :ref:`Partner password` to use. + +.. code:: json + + { + "userAuthToken": "XXX", + "syncTime": XXX + } + +.. csv-table:: + :header: Name,Type,Description + + canSubscribe,boolean,false if user is a Pandora One subscriber + isSubscriber,boolean,true if user is a Pandora One Subscriber + +.. code:: json + + { + "stat": "ok", + "result": { + "canSubscribe": false, + "isSubscriber": true + } + } -- cgit v1.2.3