Stripe.Capability (stripity_stripe v2.17.3) View Source

Work with Stripe Connect capability objects.

You can:

Link to this section Summary

Types

requirements()

t()

Functions

list(params, opts \\ [])

Returns a list of capabilities associated with the account

retrieve(id, params, opts \\ [])

Retrieves information about the specified Account Capability.

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

Updates an existing Account Capability.

Link to this section Types

requirements()

Specs

requirements() :: %{
  current_deadline: Stripe.timestamp() | nil,
  currently_due: Stripe.List.t(String.t()) | nil,
  disabled_reason: String.t() | nil,
  eventually_due: Stripe.List.t(String.t()) | nil,
  past_due: Stripe.List.t(String.t()) | nil,
  pending_verification: Stripe.List.t(String.t()) | nil
}

t()

Specs

t() :: %Stripe.Capability{
  account: Stripe.Account.t(),
  id: String.t(),
  object: String.t(),
  requested: boolean() | nil,
  requested_at: Stripe.timestamp(),
  requirements: requirements() | nil,
  status: String.t() | nil
}

Link to this section Functions

list(params, opts \\ [])

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{account: Stripe.id()}

Returns a list of capabilities associated with the account

retrieve(id, params, opts \\ [])

Specs

retrieve(Stripe.id(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{account: Stripe.id()}

Retrieves information about the specified Account Capability.

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

Specs

update(Stripe.id(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{:account => Stripe.id(), optional(:requested) => boolean()}

Updates an existing Account Capability.