Return cPanel Store or Market checkout URL

This function returns the checkout URL to use for a cPanel Store or cPanel Market provider purchase.

SecurityBasicAuth

Request

query Parameters

login_token required	string The login token to access the cPanel Store. Example: login_token=1a676e6f-99fc-11e6-9ab6-e60a769b73bc
provider required	string The cPanel Store or cPanel Market provider's name. Example: provider=cPStore
url_after_checkout required	string <url> The location to which the cPanel Store or cPanel Market provider directs the user after the checkout process finishes. Example: url_after_checkout=http://hostname.example.com
upgrade	integer Default: 0 Whether the cPanel Store or cPanel Market provider should treat this request as an upgrade. `1` — An upgrade. `0` — Not an upgrade. Enum: 0 1 Example: upgrade=1

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/purchase_a_license

Request samples

whmapi1 --output=jsonpretty \
  purchase_a_license \
  provider='cPStore' \
  url_after_checkout='http://hostname.example.com' \
  login_token='1a676e6f-99fc-11e6-9ab6-e60a769b73bc'

Response samples

application/json

{"data": {"payload": ["https://store.cpanel.net/checkout/ssl/1234567"
]
},
"metadata": {"command": "purchase_a_license",
"reason": "OK",
"result": 1,
"version": 1
}
}