Skip to main content
Start selling

Retrieve the pricing table data

GET 
https://api.freemius.com/v1/products/{product_id}/pricing.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 plugin's full features & pricing data for a pricing table. Used by our JS SDK, and WordPress SDK to create pricing components and pages.

Request​

Path Parameters

    product_id integer<int64>required

    The ID of the product.

    Possible values: >= 1

    Example: 1234

Query Parameters

    currency string

    The currency to use for the pricing.

    Possible values: >= 3 characters and <= 3 characters, [usd, eur, gbp]

    show_pending boolean
    Default value: false
    type any
    Default value: all

    Whether to show all plans or only the visible ones.

    Possible values: [all, visible]

    is_enriched boolean
    Default value: false

    If set to true, the result will be enriched with some of the context plugin's information.

    bundle_product_id string

    (optional) (Development Only) The ID of the parent bundle product. When getting the pricing of a product, if the product is part of a bundle, you can set the value here (along with the public key of the bundle). This will be used to determine the trial status of the product in sandbox mode. Our WP SDK uses it internally.

    bundle_product_public_key string

    (optional) (Development Only) Used alongside the bundle_product_id parameter.

Responses​

The features and pricing data.

Schema
plugin object
iconstringnullable

Product's icon (profile picture).

Example: https://img.freemius.com/plugin-icon-blue.png
slugstring

The slug of the product. If your plugin is listed on WordPress.org repository, use the exact slug.

Example: my-freemius-plugin
titlestring

The title of the product.

Example: My Freemius Plugin
typestring

Possible values: [plugin, theme, widget, template]

money_back_periodinteger

Money-back guarantee in days.

refund_policystring

Possible values: [flexible, moderate, strict]

public_keystring

The public key associated with the entity for authorization.

Example: pk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
parent_plugin_idstring<int64>nullable

If the product is an add-on then this is the ID of the parent product.

Possible values: >= 1

Example: 123456
selling_unit_label object

The label used for the selling unit of the product, e.g., 'Credit', 'Activation', etc. The resulting object will have both singular and plural.

singularstring

The singular form of the selling unit label.

Example: Credit
pluralstring

The plural form of the selling unit label.

Example: Credits
plans 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
    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.

    pricing 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
    currencystring

    3-char currency code.

    Possible values: >= 3 characters and <= 3 characters, [usd, eur, gbp]

    plan_idstring<int64>

    The ID of the plan.

    Possible values: >= 1

    Example: 1234
    licensesintegernullable

    The number of activations or quota supported by the license that will be created through the pricing (Using Freemius Checkout). Use null for unlimited activations or quota.

    Example: 10
    monthly_pricenumber<float>nullable

    The price for a single month.

    Example: 59.99
    annual_pricenumber<float>nullable

    The price for one year.

    Example: 159.99
    lifetime_pricenumber<float>nullable

    The lifetime price.

    Example: 359.99
    is_whitelabeledboolean

    Whether to whitelabel the license that will be created from this pricing upon successful Checkout.

    is_hiddenboolean

    Whether to hide the pricing from checkout and the pricing page in the WP dashboard.

  • ]
    • features 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 Plugin.

    Possible values: >= 1

    Example: 1234
    titlestring

    The title of the feature.

    Example: Pageviews per month
    descriptionstring

    The description of the feature, up to 256 characters. This will be displayed as the description in the tooltip on the pricing page.

    Example: The number of times a page is loaded.
    is_featuredboolean

    Whether the feature is highlighted and will be shown in the main pricing table. If set as false, the feature will be only shown in the plans' comparison table.

    Example: true
    valuestring

    The value of the feature associated with the plan. For example the feature name could be "AI Credits" and the value could be "1000".

    Example: 1000 Units
    plan_idstring<int64>

    The ID of the plan associated with the entity.

    Possible values: >= 1

    Example: 123456
  • ]
  • ]
    • reviews object[]

    Verified and featured reviews of the product.

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

    The external ID of the review (in case migrating from another system).

    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
    rateinteger

    The score of the review.

    Possible values: >= 0 and <= 100

    Example: 80
    titlestring

    The title of the review.

    Example: Great plugin! It works perfectly.
    textstring

    The content of the review.

    Example: I love this plugin! It has all the features I need and more. The support team is also very responsive and helpful. Highly recommend!
    namestring

    The full name of the reviewer.

    Example: John Doe
    job_titlestring

    The job title of the reviewer.

    Example: Software Engineer
    companystring

    The company name of the reviewer.

    Example: Example Software Inc.
    company_urlstring

    The URL of the entity.

    Example: https://www.example.com
    picturestring<binary>

    The icon of the entity, must be a valid JPG, PNG or GIF image, with dimension not exceeding 300px by 300px. Max allowed size is 200KB

    profile_urlstring

    The URL of the reviewer's profile.

    Example: https://example.com/profile
    license_idstring<int64>

    The ID of the license associated with the entity.

    Possible values: >= 1

    Example: 123456
    is_verifiedboolean
    Default value: true

    Whether this is a genuine review generated by a real user.

    is_featuredboolean
    Default value: false

    Whether the review should be included in marketing material (e.g. pricing page).

  • ]
    • active_installsinteger

    The estimated number of active installs of the product.

    Example: 10000
    downloadsinteger

    The estimated number of downloads of the product.

    Example: 5000
    all_plans_single_site_pricing object

    Single site pricing for all plans indexed by plan ID

    property name* object

    The key represents the ID of the plan

    monthly_price object

    Monthly pricing in different currencies

    usdnumber<float>
    Example: 9.99
    gbpnumber<float>
    Example: 7.99
    eurnumber<float>
    Example: 8.99
    annual_price object

    Annual pricing in different currencies

    usdnumber<float>
    Example: 99.99
    gbpnumber<float>
    Example: 79.99
    eurnumber<float>
    Example: 89.99
    lifetime_price object

    Lifetime pricing in different currencies

    usdnumber<float>
    Example: 299.99
    gbpnumber<float>
    Example: 249.99
    eurnumber<float>
    Example: 279.99
    checkout_urlstring

    The URL to the Freemius Checkout. You need to append the product id and plan id as necessary. Please refer to the Checkout documentation for more information.

    Example: https://checkout.freemius.com
    fs_wp_endpoint_urlstring

    The URL to the Freemius WP Endpoint. This is internally used by the Freemius SDK.

    Example: https://wp.freemius.com
    trial_modeboolean

    Whenther the product supports trial for the current install/site. This is relevant for WP products only.

    Example: true
    trial_utilizedboolean

    Whether the trial has been utilized for the current install/site. This is relevant for WP products only.

    Example: false
    We use essential cookies to enable our site to function. With your consent, we also use analytics and advertising cookies to understand how visitors interact with our site and to improve our services.
    Learn More