View Source ExChargebee.Customer (ex_chargebee v0.4.1)

An interface for Interacting with customers

For More information see Chargebee customer Documentation

Summary

Functions

Perform a add_contact on individual customer.

Perform a assign_payment_role on individual customer.

Perform a change_billing_date on individual customer.

Perform a clear_personal_data on individual customer.

Perform a collect_payment on individual customer.

Perform a contacts on individual customer.

Creates a customer.

Perform a delete on individual customer.

Perform a delete_contact on individual customer.

Perform a delete_relationship on individual customer.

Perform a hierarchy on individual customer.

Returns a list of customers. Pagination is handled automatically unless the opt paginate is set to false.

Returns a list of customers payment_vouchers.

Merge from_customer_id into to_customer_id

Perform a customer move.

Perform a record_excess_payment on individual customer.

Perform a relationships on individual customer.

Returns a stream of customers. Pagination is handled automatically as the stream is consumed.

Perform a subscription_for_items on individual customer.

Perform a update_billing_info on individual customer.

Perform a update_contact on individual customer.

Perform a update_hierarchy_settings on individual customer.

Perform a update_payment_method on individual customer.

Functions

Link to this function

add_contact(resource_id, params \\ %{}, opts \\ [])

View Source
@spec add_contact(String.t(), map(), keyword()) :: map() | nil

Perform a add_contact on individual customer.

Find more information in the Chargebee Documentation

Link to this function

assign_payment_role(resource_id, params \\ %{}, opts \\ [])

View Source
@spec assign_payment_role(String.t(), map(), keyword()) :: map() | nil

Perform a assign_payment_role on individual customer.

Find more information in the Chargebee Documentation

Link to this function

change_billing_date(resource_id, params \\ %{}, opts \\ [])

View Source
@spec change_billing_date(String.t(), map(), keyword()) :: map() | nil

Perform a change_billing_date on individual customer.

Find more information in the Chargebee Documentation

Link to this function

clear_personal_data(resource_id, params \\ %{}, opts \\ [])

View Source
@spec clear_personal_data(String.t(), map(), keyword()) :: map() | nil

Perform a clear_personal_data on individual customer.

Find more information in the Chargebee Documentation

Link to this function

collect_payment(resource_id, params \\ %{}, opts \\ [])

View Source
@spec collect_payment(String.t(), map(), keyword()) :: map() | nil

Perform a collect_payment on individual customer.

Find more information in the Chargebee Documentation

Link to this function

contacts(resource_id, params \\ %{}, opts \\ [])

View Source
@spec contacts(String.t(), map(), keyword()) :: map() | nil

Perform a contacts on individual customer.

Find more information in the Chargebee Documentation

Link to this function

create(params, opts \\ [])

View Source

Creates a customer.

Find more information in the Chargebee Documentation

Link to this function

delete(resource_id, params \\ %{}, opts \\ [])

View Source
@spec delete(String.t(), map(), keyword()) :: map() | nil

Perform a delete on individual customer.

Find more information in the Chargebee Documentation

Link to this function

delete_contact(resource_id, params \\ %{}, opts \\ [])

View Source
@spec delete_contact(String.t(), map(), keyword()) :: map() | nil

Perform a delete_contact on individual customer.

Find more information in the Chargebee Documentation

Link to this function

delete_relationship(resource_id, params \\ %{}, opts \\ [])

View Source
@spec delete_relationship(String.t(), map(), keyword()) :: map() | nil

Perform a delete_relationship on individual customer.

Find more information in the Chargebee Documentation

Link to this function

hierarchy(resource_id, params \\ %{}, opts \\ [])

View Source
@spec hierarchy(String.t(), map(), keyword()) :: map() | nil

Perform a hierarchy on individual customer.

Find more information in the Chargebee Documentation

Link to this function

list(params \\ %{}, opts \\ [])

View Source
@spec list(
  map(),
  keyword()
) :: [map()] | nil

Returns a list of customers. Pagination is handled automatically unless the opt paginate is set to false.

opts:

  • site: the site to use for the request. Defaults to the default site.
  • paginate: whether to paginate the results. Defaults to false. If false, all results will be returned.
Link to this function

list_payment_vouchers(resource_id, params \\ %{}, opts \\ [])

View Source
@spec list_payment_vouchers(String.t(), map(), keyword()) :: [map()] | nil

Returns a list of customers payment_vouchers.

Pagination is handled automatically. For more information see the Chargebee Documentation

Link to this function

merge(to_customer_id, from_customer_id, opts \\ [])

View Source

Merge from_customer_id into to_customer_id

This API moves a customer's payment methods, subscriptions, invoices, credit notes, transactions, unbilled charges, and orders to another customer. Events and email logs will not be moved. The API execution is asynchronous.

Link to this function

move(params, opts \\ [])

View Source
@spec move(
  map(),
  keyword()
) :: map() | nil

Perform a customer move.

Find more information in the Chargebee Documentation

Link to this function

record_excess_payment(resource_id, params \\ %{}, opts \\ [])

View Source
@spec record_excess_payment(String.t(), map(), keyword()) :: map() | nil

Perform a record_excess_payment on individual customer.

Find more information in the Chargebee Documentation

Link to this function

relationships(resource_id, params \\ %{}, opts \\ [])

View Source
@spec relationships(String.t(), map(), keyword()) :: map() | nil

Perform a relationships on individual customer.

Find more information in the Chargebee Documentation

Link to this function

resource_base_path(path \\ "")

View Source
Link to this function

resource_path(id, path \\ "")

View Source
Link to this function

retrieve(resource_id, opts \\ [])

View Source
@spec retrieve(
  String.t(),
  keyword()
) :: map() | nil
Link to this function

stream_list(params \\ %{}, opts \\ [])

View Source
@spec stream_list(
  map(),
  keyword()
) :: Enumerable.t()

Returns a stream of customers. Pagination is handled automatically as the stream is consumed.

Link to this function

subscription_for_items(resource_id, params \\ %{}, opts \\ [])

View Source
@spec subscription_for_items(String.t(), map(), keyword()) :: map() | nil

Perform a subscription_for_items on individual customer.

Find more information in the Chargebee Documentation

Link to this function

update(resource_id, params, path \\ "", opts \\ [])

View Source

Updates a customer.

Find more information in the Chargebee Documentation

Link to this function

update_billing_info(resource_id, params \\ %{}, opts \\ [])

View Source
@spec update_billing_info(String.t(), map(), keyword()) :: map() | nil

Perform a update_billing_info on individual customer.

Find more information in the Chargebee Documentation

Link to this function

update_contact(resource_id, params \\ %{}, opts \\ [])

View Source
@spec update_contact(String.t(), map(), keyword()) :: map() | nil

Perform a update_contact on individual customer.

Find more information in the Chargebee Documentation

Link to this function

update_hierarchy_settings(resource_id, params \\ %{}, opts \\ [])

View Source
@spec update_hierarchy_settings(String.t(), map(), keyword()) :: map() | nil

Perform a update_hierarchy_settings on individual customer.

Find more information in the Chargebee Documentation

Link to this function

update_payment_method(resource_id, params \\ %{}, opts \\ [])

View Source
@spec update_payment_method(String.t(), map(), keyword()) :: map() | nil

Perform a update_payment_method on individual customer.

Find more information in the Chargebee Documentation