mollie v0.3.0 Mollie.Customers.Subscriptions

Link to this section Summary

Functions

Create a subscription to schedule recurring payments to take place at regular intervals.

Retrieve a subscription by its ID and its customer’s ID.

Retrieve all subscriptions of a customer. Results are paginated.

Retrieve all payments of a specific subscriptions of a customer. Results are paginated.

Link to this section Functions

Link to this function

cancel(client, customer_id, id, params \\ %{})

cancel(Mollie.Client.t(), binary(), binary(), map() | list()) ::
  Mollie.response()

Cancels a subscription.

Example

Mollie.Customers.Subscriptions client, "cst_stTC2WHAuS", "sub_rVKGtNd6s3"

More info at: https://docs.mollie.com/reference/v2/subscriptions-api/cancel-subscription

Link to this function

create(client, customer_id, body \\ %{})

create(Mollie.Client.t(), binary(), map()) :: Mollie.response()

Create a subscription to schedule recurring payments to take place at regular intervals.

Subscription body example

%{
  "amount" => %{
    "value" => "19.95",
    "currency" => "EUR"
  },
  "interval" => "1 month",
  "description" => "Monthly subscription"
}

Example

Mollie.Customers.Subscriptions client, "cst_8wmqcHMN4U", subscription_body

More info at: https://docs.mollie.com/reference/v2/subscriptions-api/create-subscription

Link to this function

find(client, customer_id, id, params \\ %{})

find(Mollie.Client.t(), binary(), binary(), map() | list()) ::
  Mollie.response()

Retrieve a subscription by its ID and its customer’s ID.

Example

Mollie.Customers.Subscriptions.find client, "cst_8wmqcHMN4U", "sub_rVKGtNd6s3"

More info at: https://docs.mollie.com/reference/v2/subscriptions-api/get-subscription

Link to this function

list(client, customer_id, params \\ %{})

list(Mollie.Client.t(), binary(), map() | list()) :: Mollie.response()

Retrieve all subscriptions of a customer. Results are paginated.

Example

Mollie.Customers.Subscriptions.list client, "cst_8wmqcHMN4U"

More info at: https://docs.mollie.com/reference/v2/subscriptions-api/list-subscriptions

Link to this function

list_payments(client, customer_id, id, params \\ %{})

list_payments(Mollie.Client.t(), binary(), binary(), map() | list()) ::
  Mollie.response()

Retrieve all payments of a specific subscriptions of a customer. Results are paginated.

Example

Mollie.Customers.Subscriptions.list_payments client, "cst_8wmqcHMN4U", "sub_rVKGtNd6s3"

More info at: https://docs.mollie.com/reference/v2/subscriptions-api/list-subscriptions-payments