Paddle.Subscription.list
You're seeing just the function
list
, go back to Paddle.Subscription module for more information.
Specs
list(keyword()) :: {:ok, [t()]} | {:error, Paddle.Error.t()}
List all users subscribed to any of your subscription plans
Optionally also accepts plan_id
, subscription_id
, and state
to filter the response to just users of a specific plan, a user subscription, or the status of the user’s subscription.
If not filtering by the subscription_id
, it is strongly recommend to utilize results_per_page
and page
to limit the amount of results returned within each API call. This ensures that the response time remains quick and consistent as the amount of user subscriptions build up over time.
Examples
Paddle.Subscriber.list()
{:ok, [
%Paddle.Subscriber{
subscription_id: 502198,
plan_id: 496199,
user_id: 285846,
user_email: "name@example.com",
marketing_consent: true,
update_url: "https://checkout.paddle.com/subscription/update?user=12345&subscription=87654321&hash=eyJpdiI6Ik1RTE1nbHpXQmtJUG5...",
cancel_url: "https://checkout.paddle.com/subscription/cancel?user=12345&subscription=87654321&hash=eyJpdiI6IlU0Nk5cL1JZeHQyTXd...",
state: "active",
signup_date: ~U"2015-10-06 09:44:23Z",
last_payment: %{
"amount" => 5,
"currency" => "USD",
"date" => ~D"2015-10-06"
},
payment_information: %{
"payment_method" => "card",
"card_type" => "visa",
"last_four_digits" => "1111",
"expiry_date" => "02/2020"
},
next_payment: %{
"amount" => 10,
"currency" => "USD",
"date" => ~D"2015-11-06"
}
}
]}