# List all licenses ``` GET https://api.freemius.com/v1/products/{product_id}/licenses.json ``` #### Auth:Bearer TokenSCOPE: PRODUCT Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need. 1. Go to the [Freemius Developer Dashboard](https://dashboard.freemius.com/). 2. Open the Settings page of the relevant product. 3. Click the API & Keys tab. 4. Copy the API Bearer Authorization Token from the UI. *** Retrieve the license collection associated with a product. ## Request[​](#request "Direct link to request") ### Path Parameters * **product\_id** integer\[](#param-property-licenses-list-param-path-product-id "Direct link to product_id")required The ID of the product. **Possible values:** `>= 1` **Example: **`1234` ### Query Parameters * **filter** string[](#param-property-licenses-list-param-query-filter "Direct link to filter") Filter licenses by status. **Possible values:** \[`active`, `cancelled`, `expired`, `abandoned`, `migrated`] **Example: **`active` **plan\_id** number[](#param-property-licenses-list-param-query-plan-id "Direct link to plan_id") Filter licenses by plan ID. **Example: **`123` **search** string[](#param-property-licenses-list-param-query-search "Direct link to search") Search license id or key. **Example: **`123` **enriched** boolean[](#param-property-licenses-list-param-query-enriched "Direct link to enriched") **Default value: **`false` If `true`, returns the associated user information. **Example: **`true` **count** integer[](#param-property-licenses-list-param-query-count "Direct link to count") **Default value: **`25` The number of records to return. **Possible values:** `>= 1` and `<= 50` **Example: **`10` **offset** integer[](#param-property-licenses-list-param-query-offset "Direct link to offset") **Default value: **`0` The number of records to skip before starting to return records. Default is 0. **Possible values:** `>= 0` **Example: **`10` **fields** string[](#param-property-licenses-list-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` **source** number[](#param-property-licenses-list-param-query-source "Direct link to source") If set, returns only licenses that are associated with the given source ID. **Example: **`123` ## Responses[​](#responses "Direct link to Responses") * 200 * 400 * 401 * 402 * 404 The licenses collection is retrieved. application/json **Schema** **licenses** object\[] * Array \[ **id**string\[](#schema-property-licenses-list-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-response-schema-is-cancelled-boolean "Direct link to is_cancelled") If the license is canceled from the Developer Dashboard. **is\_whitelabeled**boolean[](#schema-property-licenses-list-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-licenses-list-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-licenses-list-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`] **parent\_plan\_id**number[](#schema-property-licenses-list-response-schema-parent-plan-id-number "Direct link to parent_plan_id") The ID of the associated bundle license (**Only** available when `enriched` option is set). **trial\_ends**string\[](#schema-property-licenses-list-response-schema-trial-ends-string-date-time "Direct link to trial_ends") The end date of a trial subscription (**Only** available when `enriched` option is set). **Example: **`2021-01-01 00:00:00` **subscription\_id**string\[](#schema-property-licenses-list-response-schema-subscription-id-string-int64 "Direct link to subscription_id") The ID of the associated subscription (**Only** available when `enriched` option is set). **Possible values:** `>= 1` **Example: **`1234` **subscription\_total\_gross**number\[](#schema-property-licenses-list-response-schema-subscription-total-gross-number-float "Direct link to subscription_total_gross") The total gross price associated with the subscription (**Only** available when `enriched` option is set). **Example: **`102.34` **subscription\_initial\_amount**number\[](#schema-property-licenses-list-response-schema-subscription-initial-amount-number-float "Direct link to subscription_initial_amount") The initial amount associated with the subscription (**Only** available when `enriched` option is set). **Example: **`105.99` **subscription\_gateway**string[](#schema-property-licenses-list-response-schema-subscription-gateway-string "Direct link to subscription_gateway") The payment gateway associated with the subscription (**Only** available when `enriched` option is set). **Possible values:** \[`paypal`, `stripe`, `test`] **Example: **`stripe` **subscription\_failed\_payments**integer[](#schema-property-licenses-list-response-schema-subscription-failed-payments-integer "Direct link to subscription_failed_payments") The number of failed payments associated with the subscription (**Only** available when `enriched` option is set). **Example: **`2` **next\_payment**string\[](#schema-property-licenses-list-response-schema-next-payment-string-date-time "Direct link to next_payment")nullable The renewal date of the subscription (**Only** available when `enriched` option is set). **Example: **`2025-01-01 00:00:00` **parent\_license\_id**string\[](#schema-property-licenses-list-response-schema-parent-license-id-string-int64 "Direct link to parent_license_id") The ID of the associated bundle license. This will be populated only when the license is associated with a parent license from a bundle (**Only** available when `enriched` option is set). **Possible values:** `>= 0` **Example: **`1234` **parent\_license\_bundle\_id**string\[](#schema-property-licenses-list-response-schema-parent-license-bundle-id-string-int64 "Direct link to parent_license_bundle_id") The ID of the bundle that is associated with the parent license (**Only** available when `enriched` option is set). **Possible values:** `>= 0` **Example: **`1234` **parent\_plan\_title**string[](#schema-property-licenses-list-response-schema-parent-plan-title-string "Direct link to parent_plan_title")nullable The title of the plan associated with the bundle (**Only** available when `enriched` option is set). **Example: **`Agency` **parent\_plan\_name**string[](#schema-property-licenses-list-response-schema-parent-plan-name-string "Direct link to parent_plan_name")nullable The slug of the plan associated with the bundle (**Only** available when `enriched` option is set). **Example: **`agency` * ] Bad request. The request could not be understood by the server due to malformed syntax or arguments. application/json **Schema** **path**string[](#schema-property-licenses-list-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-licenses-list-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-licenses-list-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-licenses-list-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-licenses-list-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-licenses-list-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-licenses-list-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"}` Unauthorized access error. The request requires [authentication](https://freemius.com/help/api/#bearer-token-authentication) but was not provided or the provided authentication does not satisfy the required permissions. application/json **Schema** **path**string[](#schema-property-licenses-list-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-licenses-list-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-licenses-list-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-licenses-list-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-licenses-list-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-licenses-list-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-licenses-list-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-licenses-list-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-licenses-list-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-licenses-list-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-licenses-list-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-licenses-list-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-licenses-list-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-licenses-list-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-licenses-list-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-licenses-list-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-licenses-list-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"}`