List products
Returns a paginated list of products. Use the query parameters to page through results.
By default, Paddle returns products that are active
. Use the status
query parameter to return products that are archived.
Use the include
parameter to include related price entities in the response.
Query Parameters
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next
URL in responses for list operations.
Return only the IDs specified. Use a comma-separated list to get multiple entities.
Include related entities in the response. Use a comma-separated list to specify multiple entities.
Order returned entities by the specified field and direction ([ASC]
or [DESC]
). For example, ?order_by=id[ASC]
.
Valid fields for ordering: created_at
, custom_data
, description
, id
, image_url
, name
, status
, tax_category
, and updated_at
.
Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page
in the response to see how many were returned.
Default: 50
; Maximum: 200
.
Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
Return entities that match the specified tax category. Use a comma-separated list to specify multiple tax categories.
Return items that match the specified type.
Response
Represents a product entity with included entities.
Unique Paddle ID for this product, prefixed with pro_
.
Name of this product.
Short description for this product.
Type of item. Standard items are considered part of your catalog and are shown on the Paddle web app.
Tax category for this product. Used for charging the correct rate of tax. Selected tax category must be enabled on your Paddle account.
Image for this product. Included in the checkout and on some customer documents.
Your own structured key-value data.
Whether this entity can be used in Paddle.
Import information for this entity. null
if this entity is not imported.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Represents a price entity.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Keys used for working with paginated results.