Licenses

These endpoints return licenses that are owned by you, or by an organization you’re a member of.

TIP

To work with licenses created for your plugins (as a plugin developer), use the Plugin Licenses API instead.

List plugin licenses

To list plugin licenses owned by you, make an authenticated GET request to /v1/licenses/plugins.

To list plugin licenses owned by an organization you’re a member of, make the request to /v1/org/<org-slug>/licenses/plugins instead.

Licenses will be paginated.

Parameters

The following optional query string parameters are supported:

Parameter	Description
includeTrials	Set to 1 to include trial licenses in the response.
pluginHandle	Plugin handle
edition	Comma-delimited list of plugin edition handles
search	Case-insensitive search of plugin handle, key, email, and notes, plus the associated Craft license’s key and domain
before	Filter licenses created before the given datetime (UTC)
after	Filter licenses created after the given datetime (UTC)
orderBy	dateCreated (default), expiresOn, key, email, or pluginHandle
ascending	Set to 0 for descending

Definition

GET https://api.craftcms.com/v1/licenses/plugins
GET https://api.craftcms.com/v1/org/<org-slug>/licenses/plugins

Example Request

Example Response Body

{
  "total": 3,
  "totalPages": 1,
  "licenses": [
    {
      "id": 649,
      "pluginId": 1237,
      "editionId": 1415,
      "ownerId": 1,
      "cloudProjectId": null,
      "cmsLicenseId": 1840,
      "pluginHandle": "commerce",
      "edition": "pro",
      "trial": false,
      "expirable": true,
      "expired": false,
      "autoRenew": true,
      "reminded": false,
      "renewalPrice": "99.00",
      "email": "brandon@craftcms.com",
      "key": "P8GQRVQO5MK9Q673U0IJZ2I3",
      "notes": null,
      "lastVersion": "5.3.0",
      "lastAllowedVersion": "5.3.0",
      "lastActivityOn": "2038-01-19T03:14:07",
      "lastStatus": "valid",
      "lastRenewedOn": null,
      "expiresOn": "2039-01-19T03:14:07",
      "dateCreated": "2038-01-19T03:14:07",
      "dateUpdated": "2038-01-19T03:14:07",
      "uid": "2a71e0a6-e47e-4da5-9699-c6c296367619",
      "org": null
    },
    {
      // ...
    },
    {
      // ...
    }
  ]
}

Get a plugin license

To retrieve a single plugin license owned by you, make an authenticated GET request to /v1/licenses/plugins/<license-id>.

To retrieve a plugin license owned by an organization you’re a member of, make the request to /v1/org/<org-slug>/licenses/plugins/<license-id> instead.

A 404 response will be returned if the license doesn’t exist, or isn’t owned by you (or the organization).

Definition

GET https://api.craftcms.com/v1/licenses/plugins/<license-id>
GET https://api.craftcms.com/v1/org/<org-slug>/licenses/plugins/<license-id>

Example Request

Example Response Body

{
  "license": {
    "id": 649,
    "pluginId": 1237,
    "editionId": 1415,
    "ownerId": 1,
    "cloudProjectId": null,
    "cmsLicenseId": 1840,
    "pluginHandle": "commerce",
    "edition": "pro",
    "trial": false,
    "expirable": true,
    "expired": false,
    "autoRenew": true,
    "reminded": false,
    "renewalPrice": "99.00",
    "email": null,
    "key": "P8GQRVQO5MK9Q673U0IJZ2I3",
    "notes": null,
    "lastVersion": "5.3.0",
    "lastAllowedVersion": "5.3.0",
    "lastActivityOn": "2038-01-19T03:14:07",
    "lastStatus": "valid",
    "lastRenewedOn": null,
    "expiresOn": "2039-01-19T03:14:07",
    "dateCreated": "2038-01-19T03:14:07",
    "dateUpdated": "2038-01-19T03:14:07",
    "uid": "2a71e0a6-e47e-4da5-9699-c6c296367619",
    "org": "pixelandtonic"
  }
}

List Craft licenses

To list Craft CMS licenses owned by you, make an authenticated GET request to /v1/licenses/cms.

To list Craft CMS licenses owned by an organization you’re a member of, make the request to /v1/org/<org-slug>/licenses/cms instead.

Licenses will be paginated.

Parameters

The following optional query string parameters are supported:

Parameter	Description
edition	Comma-delimited list of Craft editions (solo, team, pro, or enterprise)
search	Case-insensitive search of key, domain, email, and notes
before	Filter licenses created before the given datetime (UTC)
after	Filter licenses created after the given datetime (UTC)
orderBy	dateCreated (default), expiresOn, key, email, domain, or editionHandle
ascending	Set to 0 for descending

Definition

GET https://api.craftcms.com/v1/licenses/cms
GET https://api.craftcms.com/v1/org/<org-slug>/licenses/cms

Example Request

Example Response Body

{
  "total": 2,
  "totalPages": 1,
  "licenses": [
    {
      "id": 1840,
      "editionId": 2,
      "ownerId": 1,
      "cloudProjectId": null,
      "expirable": true,
      "expired": false,
      "autoRenew": true,
      "reminded": false,
      "renewalPrice": "59.00",
      "editionHandle": "pro",
      "email": "brandon@craftcms.com",
      "domain": "craftcms.com",
      "key": "Z7M+XQ3...", // 250 characters
      "notes": null,
      "lastEdition": "pro",
      "lastVersion": "5.4.0",
      "lastAllowedVersion": "5.4.0",
      "lastActivityOn": "2038-01-19T03:14:07",
      "lastStatus": "valid",
      "lastRenewedOn": null,
      "expiresOn": "2039-01-19T03:14:07",
      "dateCreated": "2038-01-19T03:14:07",
      "dateUpdated": "2038-01-19T03:14:07",
      "uid": "6d1b5a0e-3c1f-4a8e-9f0e-1b7a2c4d5e6f",
      "org": null
    },
    {
      // ...
    }
  ]
}

Get a Craft license

To retrieve a single Craft CMS license owned by you, make an authenticated GET request to /v1/licenses/cms/<license-id>.

To retrieve a Craft CMS license owned by an organization you’re a member of, make the request to /v1/org/<org-slug>/licenses/cms/<license-id> instead.

A 404 response will be returned if the license doesn’t exist, or isn’t owned by you (or the organization).

Definition

GET https://api.craftcms.com/v1/licenses/cms/<license-id>
GET https://api.craftcms.com/v1/org/<org-slug>/licenses/cms/<license-id>

Example Request

Example Response Body

{
  "license": {
    "id": 1840,
    "editionId": 2,
    "ownerId": 1,
    "cloudProjectId": null,
    "expirable": true,
    "expired": false,
    "autoRenew": true,
    "reminded": false,
    "renewalPrice": "59.00",
    "editionHandle": "pro",
    "email": "brandon@craftcms.com",
    "domain": "craftcms.com",
    "key": "Z7M+XQ3...", // 250 characters
    "notes": null,
    "lastEdition": "pro",
    "lastVersion": "5.4.0",
    "lastAllowedVersion": "5.4.0",
    "lastActivityOn": "2038-01-19T03:14:07",
    "lastStatus": "valid",
    "lastRenewedOn": null,
    "expiresOn": "2039-01-19T03:14:07",
    "dateCreated": "2038-01-19T03:14:07",
    "dateUpdated": "2038-01-19T03:14:07",
    "uid": "6d1b5a0e-3c1f-4a8e-9f0e-1b7a2c4d5e6f",
    "org": null
  }
}