Check the status of the license

SecurityApiKeyAuth or JWTAuth
Responses
200

OK

The license has been correctly returned.

Information on customer and monthly usage are contextually attached.

401

UNAUTHORIZED

The request needs to be authenticated in some way. Available methods:

  • API Key
  • JWT Token

Please look at Authentication section for further information. You SHOULD redo the request with the proper authentication key/token.

403

FORBIDDEN

The authenticated license does not have enough permission to access the api. The most common reason is the expiration of the license

You MUST not redo the request until the issue has been sanitised.

500

INTERNAL SERVER ERROR

Something went wrong. This is the standard code for generic error.

get/license
Request samples 
Response samples 
application/json
The license bundle contains three main objects:


    

  • The kit block reports customer information, such as name and contact point
    • 

  • The usage block tracks the current consumption. start_time and end_time defines the time window, the counter defines the consumption referred to the proper term
    • 

  • The license block contains license details such as:
      

    1. The expiration date
      2. 

    2. The features
      3. 

    3. The type
      4. 

    4. The status
      5. 

    5. The pricing details
      6. 

    6. The usage limit
      7. 

    

    • 



{
  • "kit": {
    },
  • "usage": {
    },
  • "license": {
    }
}
ClickUp logo