omise
v0.10.0

Omise.Customer (omise v0.10.0)

Provides Customer API interfaces.

https://www.omise.co/customers-api

Summary

Types

t()

Functions

create(params, opts \\ [])

Create a customer.

destroy(id, opts \\ [])

Destroy a customer.

destroy_card(id, card_id, opts \\ [])

Destroy a card.

list(params \\ [], opts \\ [])

List all customers.

list_cards(id, params \\ [], opts \\ [])

List all cards that belongs to the customer.

list_schedules(id, params \\ [], opts \\ [])

List all charge schedules for a given customer.

retrieve(id, opts \\ [])

Retrieve a customer.

retrieve_card(id, card_id, opts \\ [])

Retrieve a card.

search(params \\ [], opts \\ [])

Search all the customers.

update(id, params, opts \\ [])

Update a customer.

update_card(id, card_id, params, opts \\ [])

Update a card.

Types

Link to this type

t()

@type t() :: %Omise.Customer{
  cards: Omise.List.t(),
  created: String.t(),
  default_card: String.t(),
  deleted: boolean(),
  description: String.t(),
  email: String.t(),
  id: String.t(),
  livemode: boolean(),
  location: String.t(),
  metadata: map(),
  object: String.t()
}

Functions

Link to this function

create(params, opts \\ [])

@spec create(Keyword.t(), Keyword.t()) :: {:ok, t()} | {:error, Omise.Error.t()}

Create a customer.

Returns {:ok, customer} if the request is successful, {:error, error} otherwise.

Request Parameters:

  • email - (optional) Customer's email.
  • description - (optional) A custom description for the customer.
  • card - (optional) A card token in case you want to add a card to the customer.

Examples 

# Create a customer without attaching a card
Omise.Customer.create(
  email: "lucius@omise.co",
  description: "You know, it almost makes me wish for rain"
)

# Create a customer and attach a card
Omise.Customer.create(
  email: "grouplove@omise.co",
  description: "Don't take me tongue tied",
  card: "tokn_test_51yer81s9aqqyktdoeh"
)
Link to this function

destroy(id, opts \\ [])

@spec destroy(String.t(), Keyword.t()) :: {:ok, t()} | {:error, Omise.Error.t()}

Destroy a customer.

Returns {:ok, customer} if the request is successful, {:error, error} otherwise.

Examples 

Omise.Customer.destroy("cust_test_4xtrb759599jsxlhkrb")
Link to this function

destroy_card(id, card_id, opts \\ [])

@spec destroy_card(String.t(), String.t(), Keyword.t()) ::
  {:ok, t()} | {:error, Omise.Error.t()}

Destroy a card.

Returns {:ok, card} if the request is successful, {:error, error} otherwise.

Examples 

Omise.Customer.destroy_card("cust_test_520j6g67py52xa7qbu2", "card_test_520j6g4rxrmurw16b2d")
Link to this function

list(params \\ [], opts \\ [])

@spec list(Keyword.t(), Keyword.t()) ::
  {:ok, Omise.List.t()} | {:error, Omise.Error.t()}

List all customers.

Returns {:ok, customers} if the request is successful, {:error, error} otherwise.

Query Parameters:

  • offset - (optional, default: 0) The offset of the first record returned.
  • limit - (optional, default: 20, maximum: 100) The maximum amount of records returned.
  • from - (optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records.
  • to - (optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records.

Examples 

Omise.Customer.list

Omise.Customer.list(limit: 5)
Link to this function

list_cards(id, params \\ [], opts \\ [])

@spec list_cards(String.t(), Keyword.t(), Keyword.t()) ::
  {:ok, Omise.List.t()} | {:error, Omise.Error.t()}

List all cards that belongs to the customer.

Returns {:ok, cards} if the request is successful, {:error, error} otherwise.

Query Parameters:

  • offset - (optional, default: 0) The offset of the first record returned.
  • limit - (optional, default: 20, maximum: 100) The maximum amount of records returned.
  • from - (optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records.
  • to - (optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records.
  • order - (optional, default: chronological) The order of the list returned.

Examples 

Omise.Customer.list_cards("cust_test_520j6g67py52xa7qbu2")
Link to this function

list_schedules(id, params \\ [], opts \\ [])

@spec list_schedules(String.t(), Keyword.t(), Keyword.t()) ::
  {:ok, Omise.List.t()} | {:error, Omise.Error.t()}

List all charge schedules for a given customer.

Returns {:ok, schedules} if the request is successful, {:error, error} otherwise.

Query Parameters:

  • offset - (optional, default: 0) The offset of the first record returned.
  • limit - (optional, default: 20, maximum: 100) The maximum amount of records returned.
  • from - (optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records.
  • to - (optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records.

Examples 

Omise.Customer.list_schedules("cust_test_520j6g67py52xa7qbu2")
Link to this function

retrieve(id, opts \\ [])

@spec retrieve(String.t(), Keyword.t()) :: {:ok, t()} | {:error, Omise.Error.t()}

Retrieve a customer.

Returns {:ok, customer} if the request is successful, {:error, error} otherwise.

Examples 

Omise.Customer.retrieve("cust_test_4xtrb759599jsxlhkrb")
Link to this function

retrieve_card(id, card_id, opts \\ [])

@spec retrieve_card(String.t(), String.t(), Keyword.t()) ::
  {:ok, t()} | {:error, Omise.Error.t()}

Retrieve a card.

Returns {:ok, card} if the request is successful, {:error, error} otherwise.

Examples 

Omise.Customer.retrieve_card("cust_test_520j6g67py52xa7qbu2", "card_test_520j6g4rxrmurw16b2d")
Link to this function

search(params \\ [], opts \\ [])

@spec search(Keyword.t(), Keyword.t()) ::
  {:ok, Omise.Search.t()} | {:error, Omise.Error.t()}

Search all the customers.

Returns {:ok, customers} if the request is successful, {:error, error} otherwise.

Query Parameters: 

<https://www.omise.co/search-query-and-filters>

Examples 

Omise.Customer.search(filters: [created: "2016-09-09"])

Omise.Customer.search(query: "eleven@omise.co")
Link to this function

update(id, params, opts \\ [])

@spec update(String.t(), Keyword.t(), Keyword.t()) ::
  {:ok, t()} | {:error, Omise.Error.t()}

Update a customer.

Returns {:ok, customer} if the request is successful, {:error, error} otherwise.

Request Parameters:

  • email - (optional) Customer's email.
  • description - (optional) A custom description for the customer.
  • card - (optional) A card token in case you want to add a card to the customer.

Examples 

# Update email and description.
Omise.Customer.update("cust_test_51yerhn3ghztgv31n4p",
  email: "edward@omise.co",
  description: "Home is when I’m alone with you"
)

# Attach a card to a customer.
Omise.Customer.update("cust_test_4xtrb759599jsxlhkrb",
  card: "tokn_test_4xs9408a642a1htto8z"
)
Link to this function

update_card(id, card_id, params, opts \\ [])

@spec update_card(String.t(), String.t(), Keyword.t(), Keyword.t()) ::
  {:ok, t()} | {:error, Omise.Error.t()}

Update a card.

Returns {:ok, card} if the request is successful, {:error, error} otherwise.

Request Parameters:

  • name - (optional) The cardholder name as printed on the card.
  • expiration_month - (optional) The expiration month printed on the card.
  • expiration_year - (optional) The expiration year printed on the card in the format YYYY.
  • postal_code - (optional) The postal code from the city where the card was issued.
  • city - (optional) The city where the card was issued.

Examples 

params = [expiration_month: 12, city: "Bangkok"]
Omise.Customer.update_card("cust_test_520j6g67py52xa7qbu2", "card_test_520j6g4rxrmurw16b2d", params)