paddle_list_customers: Retrieve Paddle Customers

In paddleR: Wrapper for 'Paddle' API (Application Programming Interface)

Retrieve Paddle Customers

Description

Fetches a paginated list of customers. By default, only active customers are returned.

Usage

paddle_list_customers(
  email = NULL,
  id = NULL,
  status = NULL,
  after = NULL,
  order_by = NULL,
  per_page = NULL,
  search = NULL
)

Arguments

email	Vector of email addresses to match exactly. Optional.
id	Character vector of Paddle customer IDs. Optional.
status	Characte vector of statuses to filter by ('"active"' or '"archived"'). Optional.
after	Character. Return entities after the specified Paddle ID when working with paginated endpoints. Optional.
order_by	Character. Order results by '"id[ASC]"' or '"id[DESC]"'. Optional.
per_page	Integer. Number of results per page (1–200). Optional, defaults to 50.
search	Character. Search term (one of '"id"', '"name"', '"email"'). Optional.

Value

A list with customer data and pagination info.

Examples

set_paddle_mode("sandbox")
result <- paddle_list_customers()

paddleR documentation built on June 24, 2025, 9:07 a.m.