Striped v0.1.0

View Source Stripe.Mandate (Striped v0.1.0)

A Mandate is a record of the permission a customer has given you to debit their payment method.

Link to this section Summary

Types

t()

The mandate type.

Functions

retrieve(client, mandate, params \\ %{})

Retrieves a Mandate object.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Stripe.Mandate{
  customer_acceptance: term(),
  id: binary(),
  livemode: boolean(),
  multi_use: term(),
  object: 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.
  • payment_method ID of the payment method associated with this mandate.
  • payment_method_details
  • single_use
  • status The status of the mandate, which indicates whether it can be used to initiate a payment.
  • type The type of the mandate.

Link to this section Functions

Link to this function

retrieve(client, mandate, params \\ %{})

View Source 
@spec retrieve(client :: term(), mandate :: binary(), params :: map()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves a Mandate object.

Details

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

Query parameters

  • :expand array of: string