Description

This function returns the commission configuration of all available cPanel Market providers.

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/get_market_providers_commission_config?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/get_market_providers_commission_config?api.version=1
whmapi1 get_market_providers_commission_config

{  
   "metadata":{  
      "command":"get_market_providers_commission_config",
      "result":1,
      "reason":"OK",
      "version":1
   },
   "data":{  
      "payload":[  
         {  
            "local_commission_id":"user@example.com",
            "provider_display_name":"cPanel Store",
            "remote_commission_id":"user@example.com",
            "provider_name":"cPStore"
         }
      ]
   }
}
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <command>get_market_providers_commission_config</command>
        <result>1</result>
    </metadata>
    <data>
        <payload>
            <provider_name>cPStore</provider_name>
            <local_commission_id>user@example.com</local_commission_id>
            <remote_commission_id>user@example.com</remote_commission_id>
            <provider_display_name>cPanel Store</provider_display_name>
        </payload>
    </data>
</result>

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
payloadarray of hashes

An array of hashes that contains commission ID information about a cPanel Market provider.

Each hash includes the provider_name local_commission_id, remote_commission_id, and provider_display_name returns. 

provider_name

string

This cPanel Market provider's name.

The function returns this value in the payload array.

A valid string.cPStore

local_commission_id

string

The locally-cached commission ID that the server owner uses for the cPanel Market provider.

The function returns this value in the payload array.

A valid email address.
user@example.com

remote_commission_id

string

The commission ID that the server owner uses for the cPanel Market provider.

The function returns this value in the payload array.

A valid email address.
user@example.com

provider_display_name

string

The cPanel Market provider's display name.

The function returns this value in the payload array.

A valid string.
cPanel Store