list_prices
Retrieve and filter catalog prices from your Paddle account with pagination, sorting, and options to include related product details.
Instructions
This tool will list prices in the account's catalog.
Use the maximum perPage by default (200) to ensure comprehensive results. Filter prices by id, productId, status, recurring, and type as needed. Results are paginated - use the 'after' parameter with the last ID from previous results to get the next page. Sort and order results using the orderBy parameter. Amounts are in the smallest currency unit (e.g., cents).
Use the include parameter to include related entities in the response:
product: An object for the product entity that's tied to the price.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | Return entities after the specified Paddle ID when working with paginated endpoints. | |
| id | No | Return only the IDs specified. Use a comma-separated list to get multiple entities. | |
| include | No | Include related entities in the response. | |
| orderBy | No | Order returned entities by the specified field and direction. | |
| perPage | No | Set how many entities are returned per page. Returns the maximum number of results if a number greater than the maximum is requested. | |
| productId | No | Return entities related to the specified product. Use a comma-separated list to specify multiple product IDs. | |
| status | No | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. | |
| recurring | No | Determine whether returned entities are for recurring prices (`true`) or one-time prices (`false`). | |
| type | No | Return items that match the specified type. |