# List all pricings ``` GET https://api.freemius.com/v1/products/{product_id}/addons/{addon_id}/plans/{plan_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](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 pricing collection for the addon for specific the plan. ## Request[​](#request "Direct link to request") ### Path Parameters * **product\_id** integer\[](#param-property-addons-list-pricings-param-path-product-id "Direct link to product_id")required The ID of the product. **Possible values:** `>= 1` **Example: **`1234` **addon\_id** integer\[](#param-property-addons-list-pricings-param-path-addon-id "Direct link to addon_id")required The ID of the Addon. **Possible values:** `>= 1` **Example: **`1234` **plan\_id** integer\[](#param-property-addons-list-pricings-param-path-plan-id "Direct link to plan_id")required The ID of the plan. **Possible values:** `>= 1` **Example: **`1234` ### Query Parameters * **count** integer[](#param-property-addons-list-pricings-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-addons-list-pricings-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-addons-list-pricings-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` **currency** string[](#param-property-addons-list-pricings-param-query-currency "Direct link to currency") **Possible values:** `>= 3 characters` and `<= 3 characters`, \[`usd`, `eur`, `gbp`] ## Responses[​](#responses "Direct link to Responses") * 200 * 400 * 401 * 402 * 404 The list of all the plans for the addon. application/json **Schema** **plans** object\[] * Array \[ **id**string\[](#schema-property-addons-list-pricings-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-addons-list-pricings-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-addons-list-pricings-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` **currency**string[](#schema-property-addons-list-pricings-response-schema-currency-string "Direct link to currency") 3-char currency code. **Possible values:** `>= 3 characters` and `<= 3 characters`, \[`usd`, `eur`, `gbp`] **plan\_id**string\[](#schema-property-addons-list-pricings-response-schema-plan-id-string-int64 "Direct link to plan_id") The ID of the plan. **Possible values:** `>= 1` **Example: **`1234` **licenses**integer[](#schema-property-addons-list-pricings-response-schema-licenses-integer "Direct link to licenses")nullable The number of activations or quota supported by the license that will be created through the pricing (Using [Freemius Checkout](https://freemius.com/help/documentation/selling-with-freemius/freemius-checkout-buy-button/)). Use `null` for unlimited activations or quota. **Example: **`10` **monthly\_price**number\[](#schema-property-addons-list-pricings-response-schema-monthly-price-number-float "Direct link to monthly_price")nullable The price for a single month. **Example: **`59.99` **annual\_price**number\[](#schema-property-addons-list-pricings-response-schema-annual-price-number-float "Direct link to annual_price")nullable The price for one year. **Example: **`159.99` **lifetime\_price**number\[](#schema-property-addons-list-pricings-response-schema-lifetime-price-number-float "Direct link to lifetime_price")nullable The lifetime price. **Example: **`359.99` **is\_whitelabeled**boolean[](#schema-property-addons-list-pricings-response-schema-is-whitelabeled-boolean "Direct link to is_whitelabeled") Whether to [whitelabel](https://freemius.com/help/documentation/users-account-management/license-security/#white_label_mode) the license that will be created from this pricing upon successful Checkout. **is\_hidden**boolean[](#schema-property-addons-list-pricings-response-schema-is-hidden-boolean "Direct link to is_hidden") Whether to hide the pricing from checkout and the pricing page in the WP dashboard. * ] Bad request. The request could not be understood by the server due to malformed syntax or arguments. application/json **Schema** **path**string[](#schema-property-addons-list-pricings-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-addons-list-pricings-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-addons-list-pricings-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-addons-list-pricings-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-addons-list-pricings-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-addons-list-pricings-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-addons-list-pricings-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-addons-list-pricings-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-addons-list-pricings-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-addons-list-pricings-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-addons-list-pricings-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-addons-list-pricings-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-addons-list-pricings-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-addons-list-pricings-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-addons-list-pricings-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-addons-list-pricings-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-addons-list-pricings-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-addons-list-pricings-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-addons-list-pricings-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-addons-list-pricings-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-addons-list-pricings-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-addons-list-pricings-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-addons-list-pricings-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-addons-list-pricings-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-addons-list-pricings-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-addons-list-pricings-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-addons-list-pricings-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-addons-list-pricings-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"}`