stripity_stripe v2.7.0 Stripe.Issuing.Cardholder View Source
Work with Stripe Issuing cardholder objects.
You can:
- Create a cardholder
- Retrieve a cardholder
- Update a cardholder
Stripe API reference: https://stripe.com/docs/api/issuing/cardholders
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %Stripe.Issuing.Cardholder{
authorization_controls: Stripe.Issuing.Types.authorization_controls() | nil,
billing: Stripe.Issuing.Types.billing(),
created: Stripe.timestamp(),
email: String.t() | nil,
id: Stripe.id(),
is_default: boolean() | nil,
livemode: boolean(),
metadata: Stripe.Types.metadata(),
name: String.t(),
object: String.t(),
phone_number: String.t() | nil,
status: String.t() | nil,
type: atom() | String.t()
}
t() :: %Stripe.Issuing.Cardholder{
authorization_controls: Stripe.Issuing.Types.authorization_controls() | nil,
billing: Stripe.Issuing.Types.billing(),
created: Stripe.timestamp(),
email: String.t() | nil,
id: Stripe.id(),
is_default: boolean() | nil,
livemode: boolean(),
metadata: Stripe.Types.metadata(),
name: String.t(),
object: String.t(),
phone_number: String.t() | nil,
status: String.t() | nil,
type: atom() | String.t()
}
Link to this section Functions
Link to this function
create(params, opts \\ [])
View Source
create(params, opts \\ [])
View Source
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(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.
Link to this function
list(params \\ %{}, opts \\ [])
View Source
list(params \\ %{}, opts \\ [])
View Source
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(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.
Link to this function
retrieve(id, opts \\ [])
View Source
retrieve(id, opts \\ [])
View Source
retrieve(Stripe.id() | t(), Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a cardholder.
Link to this function
update(id, params, opts \\ [])
View Source
update(id, params, opts \\ [])
View Source
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(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.