Welcome to the Freemius API Documentation!
You can use our API to access Freemius API endpoints, which can get information on various aspects of Freemius.
If you're using Freemius for a WordPress product, please check out our official SDK.
We support Bearer authentication. You can get the API Key from the Freemius Developer Dashboard for a product.
More information can be found under the Security section of every endpoint.
https://api.freemius.com/v1/
https://docs.freemius.com/_mock/api/
https://api.freemius.com/v1/products/{product_id}/features/{feature_id}.json
https://docs.freemius.com/_mock/api/products/{product_id}/features/{feature_id}.json
curl -i -X DELETE \
https://api.freemius.com/v1/products/1234/features/1234.json \
-H 'Authorization: Bearer <YOUR_AccessToken_HERE>'No contenthttps://api.freemius.com/v1/products/{product_id}/features.json
https://docs.freemius.com/_mock/api/products/{product_id}/features.json
curl -i -X GET \
'https://api.freemius.com/v1/products/1234/features.json?count=10&fields=id%2Cname%2Cslug&offset=10' \
-H 'Authorization: Bearer <YOUR_AccessToken_HERE>'{ "features": [ { … } ] }
https://api.freemius.com/v1/products/{product_id}.json
https://docs.freemius.com/_mock/api/products/{product_id}.json
curl -i -X GET \
'https://api.freemius.com/v1/products/1234.json?fields=id%2Cname%2Cslug' \
-H 'Authorization: Bearer <YOUR_AccessToken_HERE>'OK
The secret key associated with the entity for authorization.
The public key associated with the entity for authorization.
The date and time the entity was created, under UTC timezone.
The date and time the entity was updated, under UTC timezone. If null then the entity was never updated since its creation.
If the product is an add-on then this is the ID of the parent product.
The slug of the product. If your plugin is listed on WordPress.org repository, use the exact slug.
The environment the entity belongs to. 0 means it belongs to the production environment, 1 means it belongs to the sandbox environment.
Product's icon (profile picture).
The type of renewals discount, percentage or dollar.
A flag that controls the visibility of add-ons in the in-dashboard add-ons marketplace. Defaults to true. Only applicable if the product is an add-on.
A flag that controls whether the SDK should be required or not during deployment of a version. It defaults to true.
Determines if the pricing should be visible in the in-SDK pricing page. Defaults to true. Turn this off during the development of a new product.
Set to true if the free version of the module is hosted on WordPress.org. Defaults to true.
The number of "free" version of the product that were deployed from Freemius.
The number of "premium" version of the product that were deployed from Freemius.
Total number of failed payments recorded for the product.
{ "secret_key": "sk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6", "public_key": "pk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6", "id": "123456", "created": "2025-01-01 00:00:00", "updated": "2025-01-01 00:00:00", "parent_plugin_id": "123456", "developer_id": "123456", "store_id": "123456", "slug": "my-freemius-plugin", "title": "My Freemius Plugin", "environment": 0, "icon": "https://img.freemius.com/plugin-icon-blue.png", "default_plan_id": "string", "plans": "123456,123457,123458", "features": "123456,123457,123458", "money_back_period": 0, "refund_policy": "flexible", "annual_renewals_discount": 0, "renewals_discount_type": "percentage", "is_released": true, "is_sdk_required": true, "is_pricing_visible": true, "is_wp_org_compliant": true, "installs_count": 0, "active_installs_count": 0, "free_releases_count": 0, "premium_releases_count": 0, "total_purchases": 0, "total_subscriptions": 0, "total_renewals": 0, "total_failed_purchases": "1234", "earnings": "1234.56", "type": "plugin", "is_static": true }