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.
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

Path Parameters

product_id integer<int64>required
The ID of the product.
Possible values: >= 1
Example: 1234

Query Parameters

filter string
Filter licenses by status.
Possible values: [active, cancelled, expired, abandoned, migrated]
Example: active
plan_id number
Filter licenses by plan ID.
Example: 123
search string
Search license id or key.
Example: 123
enriched boolean
Default value: false
If true, returns the associated user information.
Example: true
count integer
Default value: 25
The number of records to return.
Possible values: >= 1 and <= 50
Example: 10
offset integer
Default value: 0
The number of records to skip before starting to return records. Default is 0.
Possible values: >= 0
Example: 10
fields string
Comma separated list of fields to return in the response. If not specified, all fields are returned.
Example: id,name,slug
source number
If set, returns only licenses that are associated with the given source ID.
Example: 123

Responses

200

The licenses collection is retrieved.

application/json

Schema

licenses object[]

Array [

idstring<int64>

The unique identifier of the entity.

Possible values: >= 1

Example: 123456

createdstring<date-time>

The date and time the entity was created, under UTC timezone.

Example: 2025-01-01 00:00:00

updatedstring<date-time>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_idstring<int64>

The ID of the product the entity belongs to.

Possible values: >= 1

Example: 123456

user_idstring<int64>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_idstring<int64>

The ID of the plan associated with the entity.

Possible values: >= 1

Example: 123456

pricing_idstring<int64>nullable

The ID of the pricing associated with the entity.

Possible values: >= 1

Example: 123456

quotaintegernullable

The maximum number of license activations. If null then the license will support unlimited activations.

Example: 10

activatedinteger

The total number of production activation the license has. This does not count local or staging environment activations.

Example: 1

activated_localintegernullable

The number of times the license is activated on local or staging environments.

Example: 1

expirationstring<date-time>nullable

The expiration date of the license. If null then it's a lifetime license.

Example: 2025-12-31 23:59:59

secret_keystring

The license key. This is used for activating the license on the user's site.

Example: sk_123FGqM456Pa786WtOp%^+67Y+;sXXz

is_free_localhostboolean

Default value: true

Whether the license offers unlimited local or staging environment activations.

is_block_featuresboolean

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_cancelledboolean

If the license is canceled from the Developer Dashboard.

is_whitelabeledboolean

Guide the Freemius WP SDK when the product should be running in a white-label mode.

environmentnumber

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

sourcenumber

The source of the migration data. To get support migrating from other platform please see our documentation.

• 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_idnumber

The ID of the associated bundle license (Only available when enriched option is set).

trial_endsstring<date-time>

The end date of a trial subscription (Only available when enriched option is set).

Example: 2021-01-01 00:00:00

subscription_idstring<int64>

The ID of the associated subscription (Only available when enriched option is set).

Possible values: >= 1

Example: 1234

subscription_total_grossnumber<float>

The total gross price associated with the subscription (Only available when enriched option is set).

Example: 102.34

subscription_initial_amountnumber<float>

The initial amount associated with the subscription (Only available when enriched option is set).

Example: 105.99

subscription_gatewaystring

The payment gateway associated with the subscription (Only available when enriched option is set).

Possible values: [paypal, stripe, test]

Example: stripe

subscription_failed_paymentsinteger

The number of failed payments associated with the subscription (Only available when enriched option is set).

Example: 2

next_paymentstring<date-time>nullable

The renewal date of the subscription (Only available when enriched option is set).

Example: 2025-01-01 00:00:00

parent_license_idstring<int64>

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_idstring<int64>

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_titlestringnullable

The title of the plan associated with the bundle (Only available when enriched option is set).

Example: Agency

parent_plan_namestringnullable

The slug of the plan associated with the bundle (Only available when enriched option is set).

Example: agency

]

400

Bad request. The request could not be understood by the server due to malformed syntax or arguments.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

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

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"}

401

Unauthorized access error. The request requires authentication but was not provided or the provided authentication does not satisfy the required permissions.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

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

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"}

402

The request is missing the specified argument.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

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

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"}

404

The requested resource was not found.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

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

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"}