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

paddle_list_customer_businesses(
  id,
  business_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.

business_id

Character vector of business IDs (e.g., "biz_123"). Optional.

status

Character. Status of the customer (`"active"` or `"archived"`). Optional.

after

Character. Pagination cursor: return entities after this ID. Optional.

order_by

Character. Must be one of `"id[ASC]"`, `"id[DESC]"`. Optional.

per_page

Integer. Max number of results (default: 50, max: 200). Optional.

Character. Optional search query across business fields and contacts (except status, created_at, updated_at).

Value

A list containing business data and pagination metadata.

Examples

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