stripity_stripe

stripity_stripe v2.7.0 Stripe.PaymentMethod View Source

Work with Stripe payment method objects.

Stripe API reference: https://stripe.com/docs/api/payment_methods

Link to this section Summary

Types

billing_details()
card()
t()

Functions

attach(params, opts \\ [])

Attach payment_method to customer

create(params, opts \\ [])

Create a payment method.

detach(params, opts \\ [])

Detach payment_method from customer

list(params, opts \\ [])

List all payment methods.

retrieve(id, opts \\ [])

Retrieve a payment method.

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

Update a card.

Link to this section Types

Link to this type

billing_details() View Source 
billing_details() :: %{
  optional(:address) => Stripe.Types.address(),
  optional(:email) => String.t(),
  optional(:name) => String.t(),
  optional(:phone) => String.t()
}

Link to this type

card() View Source 
card() :: %{
  exp_month: integer(),
  exp_year: integer(),
  number: String.t(),
  cvc: String.t()
}

Link to this type

t() View Source 
t() :: %Stripe.PaymentMethod{
  billing_details: %{
    address: Stripe.Types.address(),
    email: String.t() | nil,
    name: String.t() | nil,
    phone: String.t() | nil
  },
  card: Stripe.Card.t() | nil,
  created: Stripe.timestamp(),
  customer: Stripe.id() | Stripe.Customer.t() | nil,
  id: Stripe.id(),
  livemode: boolean(),
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  type: String.t()
}

Link to this section Functions

Link to this function

attach(params, opts \\ []) View Source 
attach(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       customer: Stripe.id() | Stripe.Customer.t(),
       payment_method: Stripe.id() | t()
     }

Attach payment_method to customer

Link to this function

create(params, opts \\ []) View Source 
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       :type => String.t(),
       optional(:billing_details) => billing_details(),
       optional(:card) => card(),
       optional(:metadata) => Stripe.Types.metadata()
     }

Create a payment method.

Link to this function

detach(params, opts \\ []) View Source 
detach(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{payment_method: Stripe.id() | t()}

Detach payment_method from customer

Link to this function

list(params, opts \\ []) View Source 
list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       :customer => Stripe.id() | Stripe.Customer.t(),
       :type => String.t(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

List all payment methods.

Link to this function

retrieve(id, opts \\ []) View Source 
retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a payment method.

Link to this function

update(id, params, opts \\ []) View Source 
update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:billing_details) => billing_details(),
       optional(:card) => card(),
       optional(:metadata) => Stripe.Types.metadata()
     }

Update a card.

Takes the id and a map of changes

Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/ or s
Focus search bar
?
Bring up this help dialog