LatticeStripe.Account.Capability (LatticeStripe v1.7.10)

Copy Markdown View Source

A single capability entry from Account.capabilities.

The outer capabilities map on %Account{} is keyed by Stripe's open-ended capability name strings (e.g. "card_payments", "transfers", "us_bank_account_payments"). Each value is a %Capability{}. The inner shape is stable; new capability names added by Stripe flow through automatically as new map keys.

iex> account.capabilities["card_payments"]
%LatticeStripe.Account.Capability{status: "active", requested: true, ...}

iex> LatticeStripe.Account.Capability.status_atom(
...>   account.capabilities["card_payments"]
...> )
:active

Summary

Types

t()

@type t() :: %LatticeStripe.Account.Capability{
  disabled_reason: String.t() | nil,
  extra: map(),
  requested: boolean() | nil,
  requested_at: integer() | nil,
  requirements: map() | nil,
  status: atom() | String.t() | nil
}

Functions

status_atom(s)

This function is deprecated. Status is now automatically atomized in cast/1. Access capability.status directly..
@spec status_atom(t() | String.t() | nil) :: atom()