Stripe.Issuing.Cardholder (stripity_stripe v2.17.3) View Source

individual() :: %{
  dob: %{day: pos_integer(), month: pos_integer(), year: pos_integer()},
  first_name: String.t(),
  last_name: String.t(),
  verification: %{}
}

t()

Specs

t() :: %Stripe.Issuing.Cardholder{
  billing: Stripe.Issuing.Types.billing(),
  company: %{tax_id_provided: boolean()} | nil,
  created: Stripe.timestamp(),
  email: String.t() | nil,
  id: Stripe.id(),
  individual: individual() | nil,
  livemode: boolean(),
  metadata: Stripe.Types.metadata(),
  name: String.t(),
  object: String.t(),
  phone_number: String.t() | nil,
  requirements: %{disabled_reason: String.t() | nil, past_due: list()},
  spending_controls: Stripe.Issuing.Types.spending_controls(),
  status: String.t() | nil,
  type: atom() | String.t()
}

Link to this section Functions

create(params, opts \\ [])

Specs

create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         :billing => Stripe.Issuing.Types.billing(),
         :name => String.t(),
         :type => :individual | :business_entity,
         optional(:authorization_controls) =>
           Stripe.Issuing.Types.authorization_controls(),
         optional(:email) => String.t(),
         optional(:is_default) => boolean(),
         optional(:metadata) => Stripe.Types.metadata(),
         optional(:phone_number) => String.t(),
         optional(:status) => String.t()
       }
       | %{}

Create a cardholder.

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

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:created) => String.t() | Stripe.date_query(),
         optional(:email) => String.t(),
         optional(:ending_before) => t() | Stripe.id(),
         optional(:is_default) => boolean(),
         optional(:limit) => 1..100,
         optional(:phone_number) => String.t(),
         optional(:starting_after) => t() | Stripe.id(),
         optional(:status) => String.t(),
         optional(:type) => String.t()
       }
       | %{}

List all cardholders.

retrieve(id, opts \\ [])

Specs

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

Retrieve a cardholder.

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

Specs

update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:authorization_controls) =>
           Stripe.Issuing.Types.authorization_controls(),
         optional(:email) => String.t(),
         optional(:is_default) => boolean(),
         optional(:metadata) => Stripe.Types.metadata(),
         optional(:phone_number) => String.t(),
         optional(:status) => String.t()
       }
       | %{}

Update a cardholder.