Retrieve a List of Paddle Prices — paddle_list

Fetches a paginated list of price entities from Paddle. Filters are available for ID, product, status, recurrence, and ordering. Optionally includes related products.

paddle_list_prices(
  id = NULL,
  product_id = NULL,
  status = NULL,
  include = NULL,
  order_by = NULL,
  per_page = NULL,
  after = NULL,
  recurring = NULL,
  type = NULL
)

Arguments

id: Character vector of Paddle price IDs (e.g., "pri_abc123"). Optional.
product_id: Character vector of Paddle product IDs. Optional.
status: Character vector of status filters (e.g., `"active"`, `"archived"`). Optional.
include: Character vector of related entities - default `NULL` or `"product"`. Optional.
order_by: String specifying sort field and direction (e.g., "id[ASC]"). Valid fields for ordering: `billing_cycle.frequency`, `billing_cycle.interval`, `id`, `product_id`, `quantity.maximum`, `quantity.minimum`, `status`, `tax_mode`, `unit_price.amount`, and `unit_price.currency_code`. Valid directions `"[ASC]"` and `"[DESC]"` Optional.
per_page: Number of results per page (max 200). Optional, defaults to 50.
after: Return entities after the specified Paddle ID when working with paginated endpoints. Optional.
recurring: Logical: TRUE to return recurring prices, FALSE for one-time. Optional.
type: Character. Type of item (one of `"standard"` and `"custom"`). Optional.

Value

A list of price entities and pagination metadata.

Examples

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