stripity_stripe

v2.0.0-alpha.5

stripity_stripe v2.0.0-alpha.5 Stripe.Customer

Work with Stripe customer objects.

You can:

  • Create a customer
  • Retrieve a customer
  • Update a customer
  • Delete a customer

Does not yet render lists or take options.

Stripe API reference: https://stripe.com/docs/api#customer

Summary

Types

t()

Functions

create(customer, opts \\ [])

Create a customer

delete(id, opts \\ [])

Delete a customer

response_mapping()

Returns the Stripe response mapping of keys to types

retrieve(id, opts \\ [])

Retrieve a customer

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

Update a customer

Types

t() 
t :: %Stripe.Customer{account_balance: term, business_vat_id: term, created: term, currency: term, default_source: term, delinquent: term, description: term, email: term, id: term, livemode: term, metadata: term}

Functions

create(customer, opts \\ []) 
create(t, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Create a customer.

delete(id, opts \\ []) 
delete(binary, list) :: :ok | {:error, Stripe.api_error_struct}

Delete a customer.

response_mapping() 
response_mapping :: Keyword.t

Returns the Stripe response mapping of keys to types.

retrieve(id, opts \\ []) 
retrieve(binary, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Retrieve a customer.

update(id, changes, opts \\ []) 
update(t, map, list) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Update a customer.

Takes the id and a map of changes.