exoapi_stripe v0.1.4

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

description: A return represents the full or partial return of a number of order items. Returns always belong to an order, and may optionally contain a refund.

Related guide: Handling Returns.

:amount :: :integer

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.

:created :: :integer

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

:currency :: :string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

:id :: :string

Unique identifier for the object.

::items :: ExOAPI.Stripe.Schemas.OrderItem

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

:order :: ExOAPI.Stripe.Schemas.Order | :string

The order that this return includes items from.

:refund :: ExOAPI.Stripe.Schemas.Refund | :string

The ID of the refund issued for this return.

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.OrderReturn{
  amount: integer() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  id: String.t() | nil,
  items: [ExOAPI.Stripe.Schemas.OrderItem.t()],
  livemode: boolean() | nil,
  object: :order_return | nil,
  order: ExOAPI.EctoTypes.AnyOf.t() | nil,
  refund: ExOAPI.EctoTypes.AnyOf.t() | nil
}

Link to this section Functions

Link to this function

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

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