Retrieve a plan

GET 
https://api.freemius.com/v1/products/{product_id}/plans/{plan_id}.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 a specific plan by ID.

Request

Path Parameters

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

Query Parameters

fields string
Comma separated list of fields to return in the response. If not specified, all fields are returned.
Example: id,name,slug

Responses

200

Plan listing.

application/json

Schema

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

namestring<slug>

The name of the plan. Only lowercase characters allowed.

Example: professional

titlestring

The title of the plan. This is the human readable name of the plan. Please do not add the suffix Plan to the title, as Freemius does that for you at various places.

Example: Professional

descriptionstringnullable

The description of the plan.

Example: For small to medium businesses.

is_free_localhostboolean

Default value: true

Whether the plan offers unlimited local or staging activations with the same license.

is_block_featuresboolean

Default value: true

Whether to block features on expiration of annual licenses. If false, does not block features but only block updates and support.

is_block_features_monthlyboolean

Default value: true

Whether to block particular features on expiration of monthly licenses. If false, does not block features but only block updates and support.

license_typeinteger

Default value: 0

The type of the license. 0 for per domain license. 1 for per subdomain license.

Possible values: [0, 1]

trial_periodintegernullable

The number of days a trial period will last. If null the plan does not support trials.

Possible values: >= 1

Example: 14

is_require_subscriptionboolean

Whether to require a subscription payment for the trial period.

support_kbstringnullable

The Knowledge Base URL.

Example: https://example.com/help/documentation

support_forumstringnullable

The support Forum URL.

Example: https://example.com/support

support_emailstringnullable

The support email address.

Example: [email protected]

support_phonestringnullable

The support phone contact.

Example: 555-555-5555

is_success_managerboolean

Is a personal success manager allocated with the plan.

is_featuredboolean

Whether this is a featured plan.

is_hiddenboolean

Whether to hide the plan from the auto-generated pricing page. Mostly relevant for WordPress products and our WordPress SDK. Please see our pricing-page library to implement your own.

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