exoapi_stripe v0.1.4

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

description: A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

:application :: ExOAPI.Stripe.Schemas.Application | :string

The value of application on the SetupIntent at the time of this confirmation.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:customer :: ExOAPI.Stripe.Schemas.DeletedCustomer | ExOAPI.Stripe.Schemas.Customer | :string

The value of customer on the SetupIntent at the time of this confirmation.

: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.

:object :: :string

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

:on_behalf_of :: ExOAPI.Stripe.Schemas.Account | :string

The value of on_behalf_of on the SetupIntent at the time of this confirmation.

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

ID of the payment method used with this SetupAttempt.

:payment_method_details :: ExOAPI.Stripe.Schemas.SetupAttemptPaymentMethodDetails

:setup_error :: ExOAPI.Stripe.Schemas.ApiErrors

The error encountered during this attempt to confirm the SetupIntent, if any.

:setup_intent :: ExOAPI.Stripe.Schemas.SetupIntent | :string

ID of the SetupIntent that this attempt belongs to.

:status :: :string

Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.

:usage :: :string

The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session.

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.SetupAttempt{
  application: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  customer: ExOAPI.EctoTypes.AnyOf.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  object: :setup_attempt | nil,
  on_behalf_of: ExOAPI.EctoTypes.AnyOf.t() | nil,
  payment_method: ExOAPI.EctoTypes.AnyOf.t() | nil,
  payment_method_details:
    ExOAPI.Stripe.Schemas.SetupAttemptPaymentMethodDetails.t() | nil,
  setup_error: ExOAPI.EctoTypes.AnyOf.t() | nil,
  setup_intent: ExOAPI.EctoTypes.AnyOf.t() | nil,
  status: String.t() | nil,
  usage: String.t() | nil
}

Link to this section Functions

Link to this function

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

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