---
title: "Return cPanel Store or Market checkout URL"
method: GET
path: "/purchase_a_license"
tags: ["Server Administration", "License Management"]
---

# Return cPanel Store or Market checkout URL

`GET /purchase_a_license`

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

## Query parameters

- `login_token` string, required
- `provider` string, required
- `url_after_checkout` string, url, required
- `upgrade` 0 | 1

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `payload` string[] — An array of checkout URLs. A valid checkout URL.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success * `0` — Failed .Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)
