OpenSearch/docs/reference/licensing/get-trial-status.asciidoc

[role="xpack"]
[testenv="basic"]
[[get-trial-status]]
=== Get trial status API
++++
<titleabbrev>Get trial status</titleabbrev>
++++

This API enables you to check the status of your trial license.

[float]
==== Request

`GET /_license/trial_status`

[float]
==== Description

If you want to try the features that are included in a platinum license, you can 
start a 30-day trial. 

NOTE: You are allowed to initiate a trial license only if your cluster has not
already activated a trial license for the current major product version. For
example, if you have already activated a trial for v6.0, you cannot start a new
trial until v7.0. You can, however, contact `info@elastic.co` to request an
extended trial license.

For more information about the different types of licenses, see
https://www.elastic.co/subscriptions.

==== Authorization

You must have `monitor` cluster privileges to use this API.
For more information, see
{xpack-ref}/security-privileges.html[Security Privileges].

[float]
==== Examples

The following example checks whether you are eligible to start a trial:

[source,console]
------------------------------------------------------------
GET /_license/trial_status
------------------------------------------------------------

Example response:
[source,js]
------------------------------------------------------------
{
  "eligible_to_start_trial": true
}
------------------------------------------------------------
// TESTRESPONSE[s/"eligible_to_start_trial": true/"eligible_to_start_trial": $body.eligible_to_start_trial/]