Search documentation of stripe_elixir

# StripeElixir.Services.V2.Core.AccountService (stripe_elixir v0.1.0)

Copy Markdown View Source

Account

A V2 Account is a representation of a company or individual that a Stripe user does business with. Accounts contain the contact details, Legal Entity information, and configuration required to enable the Account for use across Stripe products.

## Summary

### Functions

close(client, id, params \\ %{}, opts \\ [])

Close an Account

create(client, params \\ %{}, opts \\ [])

Create an Account

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

List Accounts

retrieve(client, id, params \\ %{}, opts \\ [])

Retrieve an Account

update(client, id, params \\ %{}, opts \\ [])

Update an Account

## Functions

# close(client, id, params \\ %{}, opts \\ [])

    @spec close(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Close an Account

Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.

# create(client, params \\ %{}, opts \\ [])

    @spec create(StripeElixir.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Create an Account

An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient.

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

    @spec list(StripeElixir.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

List Accounts

Returns a list of Accounts.

# retrieve(client, id, params \\ %{}, opts \\ [])

    @spec retrieve(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Retrieve an Account

Retrieves the details of an Account.

# update(client, id, params \\ %{}, opts \\ [])

    @spec update(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Update an Account

Updates the details of an Account.