# Retrieve an active license by UID ``` GET https://api.freemius.com/v1/products/{product_id}/installs/{install_id}/license.json ``` *** Retrieve the full information about the active license for the specified install when the UID of the install is known. > No Authorization header is required. ## Request[​](#request "Direct link to request") ### Path Parameters * **install\_id** integer\[](#param-property-installations-retrieve-active-license-by-uid-param-path-install-id "Direct link to install_id")required The ID of the install. **Possible values:** `>= 1` **Example: **`1234` **product\_id** integer\[](#param-property-installations-retrieve-active-license-by-uid-param-path-product-id "Direct link to product_id")required The ID of the product. **Possible values:** `>= 1` **Example: **`1234` ### Query Parameters * **license\_key** string[](#param-property-installations-retrieve-active-license-by-uid-param-query-license-key "Direct link to license_key")required The license key used for the activation of the install. **Example: **`sk_123FGqM456Pa786WtOp%^+67Y+;sXXz` **uid** string\[](#param-property-installations-retrieve-active-license-by-uid-param-query-uid "Direct link to uid")required The Unique identifier. It is a 32 characters long string. **Possible values:** `>= 32 characters` and `<= 32 characters` **fields** string[](#param-property-installations-retrieve-active-license-by-uid-param-query-fields "Direct link to fields") Comma separated list of fields to return in the response. If not specified, all fields are returned. **Example: **`id,name,slug` ## Responses[​](#responses "Direct link to Responses") * 200 * 400 * 402 * 404 Successful operation application/json **Schema** **id**string\[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **plugin\_id**string\[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-plugin-id-string-int64 "Direct link to plugin_id") The ID of the product the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **user\_id**string\[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-user-id-string-int64 "Direct link to user_id")nullable The ID of the user the entity belongs to. If NULL then still not associated to any user. **Possible values:** `>= 1` **Example: **`123456` **plan\_id**string\[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-plan-id-string-int64 "Direct link to plan_id") The ID of the plan associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **pricing\_id**string\[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-pricing-id-string-int64 "Direct link to pricing_id")nullable The ID of the pricing associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **quota**integer[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-quota-integer "Direct link to quota")nullable The maximum number of license activations. If `null` then the license will support unlimited activations. **Example: **`10` **activated**integer[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-activated-integer "Direct link to activated") The total number of production activation the license has. This does not count local or staging environment activations. **Example: **`1` **activated\_local**integer[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-activated-local-integer "Direct link to activated_local")nullable The number of times the license is activated on local or staging environments. **Example: **`1` **expiration**string\[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-expiration-string-date-time "Direct link to expiration")nullable The expiration date of the license. If `null` then it's a lifetime license. **Example: **`2025-12-31 23:59:59` **secret\_key**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-secret-key-string "Direct link to secret_key") The license key. This is used for activating the license on the user's site. **Example: **`sk_123FGqM456Pa786WtOp%^+67Y+;sXXz` **is\_free\_localhost**boolean[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-is-free-localhost-boolean "Direct link to is_free_localhost") **Default value: **`true` Whether the license offers unlimited local or staging environment activations. **is\_block\_features**boolean[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-is-block-features-boolean "Direct link to is_block_features") **Default value: **`true` Whether to block features after expiration of the license. If set to `false`, this would not block features, would only block updates. **is\_cancelled**boolean[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-is-cancelled-boolean "Direct link to is_cancelled") If the license is canceled from the Developer Dashboard. **is\_whitelabeled**boolean[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-is-whitelabeled-boolean "Direct link to is_whitelabeled") Guide the [Freemius WP SDK](https://github.com/Freemius/wordpress-sdk) when the product should be running in a [white-label](https://freemius.com/help/documentation/users-account-management/license-security/#white_label_mode) mode. **environment**number[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-environment-number "Direct link to environment") The environment the entity belongs to. 0 means it belongs to the production environment, 1 means it belongs to the sandbox environment. **Possible values:** \[`1`, `0`] **Example: **`0` **source**number[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-source-number "Direct link to source") The source of the migration data. To get support migrating from other platform please see our [documentation](https://freemius.com/help/documentation/migration/). * `0` - Freemius * `1` - Other * `2` - Easy Digital Downloads (EDD) * `3` - WooCommerce (WC) * `4` - Rating Widget * `5` - Gumroad * `6` - CodeCanyon * `7` - ThemeForest * `8` - AppSumo * `9` - SendOwl * `10` - WHMCS * `11` - Lemon Squeezy **Possible values:** \[`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`] Bad request. The request could not be understood by the server due to malformed syntax or arguments. application/json **Schema** **path**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` The request is missing the specified argument. application/json **Schema** **path**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` The requested resource was not found. application/json **Schema** **path**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-installations-retrieve-active-license-by-uid-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}`