> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/pricing-and-codes/price-codes-and-promotions/pricing-api.md). # Pricing API Show special prices for logged-in users, companies or promotions in the configurator. Learn the ways to request prices from the Pricing API and set them in your embed. Use the Mimeeq pricing **API endpoint** to request prices for a specific language, price list or company, then show them in the configurator. *** ## Who this article is for 1. You have your own user management system and do not want to use Mimeeq's. 2. You need to show special prices for logged-in users. 3. You want to show special promotional prices. 4. You want to pull prices from an external source and show them in our configurator. *** ## Concept and use case Let's take an example use case where you want to provide special prices when one of your commerce customers logs into your website. In this instance, you need to request from Mimeeq a special price list or price lists for this user or for the user's company. With our pricing **API endpoint** you can request prices in the ways listed below. ### 1. Using a public price list assigned to a given language This keeps it really simple and works nicely for a lot of customers. It allows you to set 1 or more price lists to a given language. Based on the display language, you pass the language parameter along with your API key and product short-code, and our API will return the public price. {% hint style="info" %} If no language is supplied, it will use your default language. {% endhint %} ### 2. Using price list IDs This allows you to add as many price list IDs as you like. In such a case, we will return the cheapest price based on the price list IDs you specify. Keep in mind that if the price is 100 in price list one and 90 in price list two, we will only return 90. {% hint style="success" %} If you wish to get the price for price lists separately, make separate API calls with one price list specified at a time. This can then be used for making some cross-analysis between the prices and displaying the difference as a discount. {% endhint %} ### 3. Using a company ID Mimeeq allows a single company to have multiple price lists. You can specify the company ID, and we will calculate the prices for this specific company based on all their price lists and return the price. {% hint style="success" %} This is very useful when you want to return the prices for users who are assigned to a company (your customer). Set up the company in the **Companies** tab of the main app dashboard and assign the price lists for that company. Copy the company ID and store it in your website backend along with the user credentials. When the user logs in, pass this ID to our API and retrieve the specific prices for that user's company. {% endhint %} {% hint style="warning" %} If you supply price list IDs, they will override the public price. If you supply a company ID, it will override everything. {% endhint %} *** ## Important information and developer docs To set the price in the Mimeeq configurator, you must set the embed snippet with the parameter below. You can also turn it on in our embed snippet controller panel. ``` data-mimeeq-use-custom-pricing ``` * **Setting the custom price:** see our developer docs at . You can also set the decimal places displayed with min/max values, as well as set the delivery date. * **API reference:** find details of our API at . Below is a screenshot from the API documentation for quick reference. We suggest heading to our dedicated API reference page, where you can test it out for yourself. ![Pricing endpoint in the Mimeeq API reference](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FLQGPMGjLvYoIcwrgJl4I%2F7d945db0-b039-49a5-8807-673606_1bek6qf.png?alt=media) {% hint style="success" %} If you need any help or have any questions, feel free to reach out to Mimeeq support. {% endhint %} *** ## Related articles
Pricing OverviewSet up currencies, markets, price lists and quantity breaks.Pricing Overview
Promotional PricesShow compare prices using promotional price lists.Promotional Prices
Additional Price CodesShow price differences between options in the configurator.Additional Price Codes
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://help.mimeeq.com/pricing-and-codes/price-codes-and-promotions/pricing-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.