List subscriptions — paddle_list_subscriptions • paddleR

Retrieves a paginated list of subscriptions from the Paddle API.

paddle_list_subscriptions(
  id = NULL,
  customer_id = NULL,
  address_id = NULL,
  price_id = NULL,
  status = NULL,
  scheduled_change_action = NULL,
  collection_mode = NULL,
  after = NULL,
  order_by = NULL,
  per_page = NULL
)

Arguments

id, customer_id, address_id, price_id: Character vectors. Optional filters.
status: Character vector. Optional. Must be one of `"active"`, `"cancelled"`, `"past_due"`, `"paused"`, `"trialing"`.
scheduled_change_action: Character vector. Optional. Must be one of `"cancel"`, `"pause"`, `"resume"`.
collection_mode: Character. Optional. Must be one of `"automatic"`, `"manual"`.
after: Character. Optional. Return entities after the specified Paddle ID when working with paginated endpoints.
order_by: Character. Optional. Must be in the form "id[ASC]" or "id[DESC]".
per_page: Integer. Optional. Max 200, defaults to 50.

Value

A list with subscription data and pagination metadata.

Examples

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