Retrieve Paddle Products — paddle_list

Fetches a paginated list of products from the Paddle API. By default, only active products are returned.

paddle_list_products(
  id = NULL,
  status = NULL,
  tax_category = NULL,
  type = NULL,
  include = NULL,
  after = NULL,
  order_by = NULL,
  per_page = NULL
)

Arguments

id: Character vector of product IDs to match. Optional.
status: Character vector of statuses to filter by (e.g., `"active"`, `"archived"`). Optional.
tax_category: Character vector of tax categories to filter. One of `"digital-goods"`, `"ebooks`, `"implementation-services"`, `"professional-services"`, `"saas"`, `"software-programming-services"`, `"standard"`, `"training-services"`, and `"website-hosting"`. Optional.
type: Character. Type of product (one of `"standard"` and `"custom"`). Optional.
include: Character vector of related entities - default `NULL` or `"prices"`. Optional.
after: Character. Return entities after the specified Paddle ID when working with paginated endpoints.. Optional.
order_by: Character. Ordering string (e.g., `"id[ASC]"`). Valid fields for ordering: `"created_at"`, `"custom_data"`, `"id"`, `"description"`, `"image_url"`, `"name"`, `"status"`, `"tax_category"`, and `"updated_at"`. Valid directions `"[ASC]"` and `"[DESC]"` Optional. Optional.
per_page: Number of products per page (max 200). Optional, defaults to 50.

Value

A list containing product data and pagination metadata.

Examples

if (FALSE) { # paddle_has_token()
set_paddle_mode("sandbox")
result <- paddle_list_products()
}