latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
License Management

Return cPanel Store or Market checkout URL

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

get/purchase_a_license

Query parameters

login_tokenstring required
Example:1a676e6f-99fc-11e6-9ab6-e60a769b73bc

The login token to access the cPanel Store.

providerstring required
Example:cPStore

The cPanel Store or cPanel Market provider's name.

url_after_checkoutstring url required
Example:http://hostname.example.com

The location to which the cPanel Store or cPanel Market provider directs the user after the checkout process finishes.

upgrade0 | 1
Example:1

Whether the cPanel Store or cPanel Market provider should treat this request as an upgrade.

  • 1 — An upgrade.
  • 0Not an upgrade.

Response

HTTP Request was successful.

Example response

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