report/accounthistory/status/get/1

 

Returns account's subscription status.

Call

https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/accounthistory/status/get/1

Parameters

token [string] (required)
    authentication token can be acquired by logging in via API sso/login/1 method
uid [string] (required)
    user id can be acquired by logging in via API sso/login/1 method

Return Values

JSON data object
    lhs_type_code: code of subscription type
    lhs_type_description: subscription type
    sub: subscription (t=true/yes, f=false/no)
    sub_active: is subscription still active (t=true/yes, f=false/no)
    sub_start: subscription start datetime
    sub_start_local: subscription start datetime in local time
    sub_expire: subscription expiry datetime
    sub_expire_local: subscription expiry datetime in local time
    sub_session_max_concurrent: number of licenses in subscription
    sub_session_max_clients: max. number of clients allowed
    sub_multi_session_license: does subscription include multi session license (t=true/yes, f=false/no)
    sub_premium_support: does subscription include premium support (t=true/yes, f=false/no)
    sub_plugin_video: does subscription include video plugin (t=true/yes, f=false/no)
    sub_plugin_audio: does subscription include audio plugin (t=true/yes, f=false/no)
    ppu: does this account include Pay Per Use (t=true/yes, f=false/no)    
    ppu_active: is Pay Per Use still active - can the credits be used (t=true/yes, f=false/no)
    ppu_expire: Pay Per Use subscription expiry datetime
    ppu_expire_local: Pay Per Use subscription expiry datetime in local time
    ppu_credits: how many Pay Per Use time is left on subscription (hh:mm:ss); in case there is no PPU time, this value might show -00:00:01
    ppu_credits_minutes: how many Pay Per Use time in minutes is still available on subscription; in case there is no PPU time, this value might show -0.0166666666666667
    currency_code: subscriber's currency code

Example

PARAMETERS
   response encoding: JSON
   uid: ::user@example.com::main
   token: secret
POST
   https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/accounthistory/status/get/1&he=JSON1
   POST: uid=::user@example.com::main, token=secret
JSON POST
   https://www.islonline.com/api/islonline-report/1-0/islonline-report.php?method=report/accounthistory/status/get/1&he=JSON1
   POST: json={ "uid" : "::user@example.com::main", "token" : "secret" }

Was this article helpful?