exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.OrderReturns (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_order_returns_id_opts()
get_order_returns_opts()

Functions

get_order_returns(client, opts \\ [])

description: <p>Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.</p>

get_order_returns_id(client, id, opts \\ [])

description: <p>Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.</p>

Link to this section Types

Link to this type

get_order_returns_id_opts()

View Source 
@type get_order_returns_id_opts() :: {:expand, String.t()}
Link to this type

get_order_returns_opts()

View Source 
@type get_order_returns_opts() ::
  {:starting_after, String.t()}
  | {:order, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}

Link to this section Functions

Link to this function

get_order_returns(client, opts \\ [])

View Source 
@spec get_order_returns(client :: ExOAPI.Client.t(), [get_order_returns_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.OrderReturn.t()]
     }
   | map()}
  | {:error, any()}

description: <p>Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.</p>

Link to this function

get_order_returns_id(client, id, opts \\ [])

View Source 
@spec get_order_returns_id(
  client :: ExOAPI.Client.t(),
  id :: String.t(),
  [get_order_returns_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.OrderReturn.t()
   | map()}
  | {:error, any()}

description: <p>Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.</p>