Products
List products
The mods available for resale, with the price of each key in credits.
GET
/productsToken permission: View catalog products:read
Use the product_id from here to generate keys. Prices are already your account's β the same amount the generation charges.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
search | text | No | Filters by product name. Up to 100 characters. |
Response
| Field | What it is |
|---|---|
product_id | The product id. It is what you send to generate keys. |
title | The product name. |
platform | The mod platform (e.g. Windows). |
credit_cost | The price, in credits, of a key of days days. |
days | The default duration: 30 days, or the longest the mod has if it has no 30-day plan. |
plans | The durations on sale, each with its price. Send the chosen days when generating. |
status.label | The mod status, as text (e.g. funcional, manutenΓ§Γ£o). |
available | true when keys can be generated right now. |
stock | Stock: status (e.g. instock, outofstock), quantity and whether stock is managed (managed). Only instock allows generating. |
image | The product image. |
total | How many products came back. |
Before generating
Only generate keys for products with available: true. A disabled or out-of-stock mod comes with available: false, and the generation is refused. The status of every mod is also on the status page.
Errors
| HTTP | When |
|---|---|
401 | Missing, invalid, deleted or expired token. |
403 | The token lacks the View catalog permission. |
422 | search longer than 100 characters. |
429 | Over the rate limit. |