Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function sets the contact ID to which a cPanel Market provider will send commission.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/set_market_provider_commission_id?api.version=1&provider=cPStore&commission_id=user%40example.com
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/set_market_provider_commission_id?api.version=1&provider=cPStore&commission_id=user%40example.com
 Command Line
whmapi1 set_market_provider_commission_id provider=cPStore commission_id=user%40example.com

Notes:

  • 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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "set_market_provider_commission_id"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>set_market_provider_commission_id</command>
    </metadata>
</result>

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
providerstring

Required

The cPanel Market provider's name.

A valid cPanel Market provider.cPStore
commission_idstring

Required

The cPanel Store ID to which to send cPanel Market commissions.

A valid cPanel Store ID.
user@example.com

Returns

This function only returns metadata.