View Source Stripe.Mandate (stripity_stripe v3.2.0)

A Mandate is a record of the permission that your customer gives you to debit their payment method.

Summary

Types

t()

The mandate type.

Functions

retrieve(mandate, params \\ %{}, opts \\ [])

Retrieves a Mandate object.

Types

t()

@type t() :: %Stripe.Mandate{
  customer_acceptance: term(),
  id: binary(),
  livemode: boolean(),
  multi_use: term(),
  object: binary(),
  on_behalf_of: binary(),
  payment_method: binary() | Stripe.PaymentMethod.t(),
  payment_method_details: term(),
  single_use: term(),
  status: binary(),
  type: binary()
}

The mandate type.

customer_acceptance
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
multi_use
object String representing the object's type. Objects of the same type share the same value.
on_behalf_of The account (if any) that the mandate is intended for.
payment_method ID of the payment method associated with this mandate.
payment_method_details
single_use
status The mandate status indicates whether or not you can use it to initiate a payment.
type The type of the mandate.

Functions

retrieve(mandate, params \\ %{}, opts \\ [])

@spec retrieve(
  mandate :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves a Mandate object.

Details

Method: get
Path: /v1/mandates/{mandate}