Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - get_market_providers_commission_config - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - get_market_providers_commission_config
Skip to end of metadata
Go to start of metadata

 

Description

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

Examples 


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


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "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"
         }
      ]
   }
}
 Output (XML)
<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>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

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