stripity_stripe v2.7.0 Stripe.OrderReturn View Source
Work with Stripe order returns.
Stripe API reference: https://stripe.com/docs/api#order_return_object
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %Stripe.OrderReturn{
amount: pos_integer(),
created: Stripe.timestamp(),
currency: String.t(),
id: Stripe.id(),
items: Stripe.List.t(Stripe.OrderItem.t()),
livemode: boolean(),
object: String.t(),
order: Stripe.id() | Stripe.Order.t() | nil,
refund: Stripe.id() | Stripe.Refund.t() | nil
}
t() :: %Stripe.OrderReturn{
amount: pos_integer(),
created: Stripe.timestamp(),
currency: String.t(),
id: Stripe.id(),
items: Stripe.List.t(Stripe.OrderItem.t()),
livemode: boolean(),
object: String.t(),
order: Stripe.id() | Stripe.Order.t() | nil,
refund: Stripe.id() | Stripe.Refund.t() | nil
}
Link to this section Functions
Link to this function
list(params \\ %{}, opts \\ [])
View Source
list(params \\ %{}, opts \\ [])
View Source
list(params, Stripe.options()) ::
{:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
optional(:created) => Stripe.date_query(),
optional(:ending_before) => t() | Stripe.id(),
optional(:ids) => Stripe.List.t(Stripe.id()),
optional(:limit) => 1..100,
optional(:order) => Stripe.Order.t(),
optional(:starting_after) => t() | Stripe.id()
}
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:created) => Stripe.date_query(), optional(:ending_before) => t() | Stripe.id(), optional(:ids) => Stripe.List.t(Stripe.id()), optional(:limit) => 1..100, optional(:order) => Stripe.Order.t(), optional(:starting_after) => t() | Stripe.id() }
List all returns.
Link to this function
retrieve(id, opts \\ [])
View Source
retrieve(id, opts \\ [])
View Source
retrieve(Stripe.id() | t(), Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a return.