mollie v0.7.2

Mollie.Customers (mollie v0.7.2)

Creates a simple minimal representation of a customer in the Mollie API to use for the Mollie Checkout and Recurring features. These customers will appear in your Mollie Dashboard where you can manage their details, and also see their payments and subscriptions.

Link to this section Summary

Functions

create(client, body)

Creates a customer.

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

Retrieve a single customer by its ID.

list(client, params \\ %{})

Retrieve all customers created. Results are paginated.

remove(client, id, params \\ %{})

Delete a customer. All mandates and subscriptions created for this customer will be canceled as well.

update(client, id, body)

Update an existing customer.

Link to this section Functions

Link to this function

create(client, body)

Specs

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

Creates a customer.

Customer body example

%{
  "name" => "Customer A",
  "email" => "customer@example.com"
}

example

 Example 

Mollie.Customers.create client, customer_body

More info at: https://docs.mollie.com/reference/v2/customers-api/create-customer

Link to this function

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

Specs

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

Retrieve a single customer by its ID.

example

 Example 

Mollie.Customers.find client, "cst_8wmqcHMN4U"

More info at: https://docs.mollie.com/reference/v2/customers-api/get-customer

Link to this function

list(client, params \\ %{})

Specs

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

Retrieve all customers created. Results are paginated.

example

 Example 

Mollie.Customers.list client

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

Link to this function

remove(client, id, params \\ %{})

Specs

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

Delete a customer. All mandates and subscriptions created for this customer will be canceled as well.

example

 Example 

Mollie.Customers.remove client, "cst_8wmqcHMN4U"

More info at: https://docs.mollie.com/reference/v2/customers-api/delete-customer

Link to this function

update(client, id, body)

Specs

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

Update an existing customer.

Customer body example

%{
  "name" => "Customer Anderson",
  "email" => "customer_anderson@example.com",
  "locale" => "en_US"
}

example

 Example 

Mollie.Customers.update client, "cst_8wmqcHMN4U", customer_body

More info at: https://docs.mollie.com/reference/v2/customers-api/update-customer