stripity_stripe v2.0.0-alpha.6 Stripe.Account

Work with Stripe account objects.

You can:

  • Retrieve your own account
  • Retrieve an account with a specified id

This module does not yet support managed accounts.

Does not yet render lists or take options.

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

Summary

Functions

Create an account

Retrieve your own account without options

Retrieve your own account with options

Retrieve an account with a specified id

Schema map indicating when a particular argument can be created on, retrieved from, or updated on the Stripe API

Types

t()
t :: %Stripe.Account{business_name: term, business_primary_color: term, business_url: term, charges_enabled: term, country: term, default_currency: term, details_submitted: term, display_name: term, email: term, external_accounts: term, id: term, legal_entity: term, managed: term, metadata: term, object: term, statement_descriptor: term, support_email: term, support_phone: term, support_url: term, timezone: term, tos_acceptance: term, transfers_enabled: term, verification: term}

Functions

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

Create an account.

retrieve()
retrieve :: {:ok, t} | {:error, Stripe.api_error_struct}

Retrieve your own account without options.

retrieve(opts)
retrieve(list) :: {:ok, t} | {:error, Stripe.api_error_struct}

Retrieve your own account with options.

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

Retrieve an account with a specified id.

schema()
schema :: map

Schema map indicating when a particular argument can be created on, retrieved from, or updated on the Stripe API.

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

Update an account.

Takes the id and a map of changes.