exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Mandate (exoapi_stripe v0.1.4)

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

:customer_acceptance :: ExOAPI.Stripe.Schemas.CustomerAcceptance

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:multi_use :: list(:map)

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:payment_method :: ExOAPI.Stripe.Schemas.PaymentMethod | :string

ID of the payment method associated with this mandate.

:payment_method_details :: ExOAPI.Stripe.Schemas.MandatePaymentMethodDetails

:single_use :: ExOAPI.Stripe.Schemas.MandateSingleUse

:status :: :string

The status of the mandate, which indicates whether it can be used to initiate a payment.

:type :: :string

The type of the mandate.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Mandate{
  customer_acceptance: ExOAPI.Stripe.Schemas.CustomerAcceptance.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  multi_use: [map()] | nil,
  object: :mandate | nil,
  payment_method: ExOAPI.EctoTypes.AnyOf.t() | nil,
  payment_method_details:
    ExOAPI.Stripe.Schemas.MandatePaymentMethodDetails.t() | nil,
  single_use: ExOAPI.Stripe.Schemas.MandateSingleUse.t() | nil,
  status: (:pending | :inactive | :active) | nil,
  type: (:single_use | :multi_use) | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()