List Addresses for a Customer

Fetches a paginated list of addresses associated with a given customer from the Paddle API. By default, only active addresses are returned.

paddle_list_customer_addresses(
  id,
  address_id = NULL,
  status = NULL,
  after = NULL,
  order_by = NULL,
  per_page = NULL,
  search = NULL
)

Arguments

id

Character. Paddle customer ID (e.g., "ctm_abc123"). Required.

address_id

Character vector of address IDs (e.g., "add_123"). Optional.

status

Character vector. Optional. Valid: "active", "archived".

after

Character. Paddle ID to start listing after (for pagination). Optional.

order_by

Character. One of `"id[ASC]"`, `"id[DESC]"`. Optional.

per_page

Integer. Number of results per page (max 200). Optional.

search

Character. Search query across most address fields. Optional. Cannot match `status`, `created_at`, or `updated_at`.

Value

A list containing address data and pagination metadata.

Examples

if (FALSE) { # paddle_has_token()
set_paddle_mode("sandbox")
result <- paddle_list_customer_addresses(id = "ctm_123")
}