View Source ExChargebee.Customer (ex_chargebee v0.4.0)

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.

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.

Merge from_customer_id into to_customer_id

Perform a customer move.

Returns a list of customers payment_vouchers.

Perform a record_excess_payment on individual customer.

Perform a relationships on individual customer.

Returns a stream of customers. Pagination is handled automatically.

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

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

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

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

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

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

Perform a contacts on individual customer.

Find more information in the Chargebee Documentation

Link to this function

create(params, path \\ "", opts \\ [])

View Source

Creates a customer.

Find more information in the Chargebee Documentation

Link to this function

delete(resource_id, params, opts \\ [])

View Source

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

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

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

Perform a hierarchy on individual customer.

Find more information in the Chargebee Documentation

Link to this function

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

View Source

Returns a list of customers.

Pagination is handled automatically.

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

Perform a customer move.

Find more information in the Chargebee Documentation

Link to this function

payment_vouchers(params, opts \\ [])

View Source

Returns a list of customers payment_vouchers.

Pagination is handled automatically.

Link to this function

record_excess_payment(resource_id, params, opts \\ [])

View Source

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

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
Link to this function

stream_list(params \\ %{}, path \\ "", opts \\ [], resource \\ "customer")

View Source

Returns a stream of customers. Pagination is handled automatically.

Link to this function

subscription_for_items(resource_id, params, opts \\ [])

View Source

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

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

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

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

Perform a update_payment_method on individual customer.

Find more information in the Chargebee Documentation