View Source ExOAPI.Stripe.SDK.Checkout (exoapi_stripe v0.1.1)

Link to this section Summary

Functions

description: <p>Returns a list of Checkout Sessions.</p>

description: <p>Retrieves a Session object.</p>

description: <p>When retrieving a Checkout Session, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>

description: <p>Creates a Session object.</p>

description: <p>A Session can be expired when it is in one of these statuses: <code>open</code> </p>

Link to this section Types

Link to this type

get_checkout_sessions_opts()

View Source
@type get_checkout_sessions_opts() ::
  {:subscription, String.t()}
  | {:starting_after, String.t()}
  | {:payment_intent, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
Link to this type

get_checkout_sessions_session_line_items_opts()

View Source
@type get_checkout_sessions_session_line_items_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
Link to this type

get_checkout_sessions_session_opts()

View Source
@type get_checkout_sessions_session_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

get_checkout_sessions(client, opts \\ [])

View Source
@spec get_checkout_sessions(client :: ExOAPI.Client.t(), [
  get_checkout_sessions_opts()
]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of Checkout Sessions.</p>

Link to this function

get_checkout_sessions_session(client, session, opts \\ [])

View Source
@spec get_checkout_sessions_session(
  client :: ExOAPI.Client.t(),
  session :: String.t(),
  [get_checkout_sessions_session_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves a Session object.</p>

Link to this function

get_checkout_sessions_session_line_items(client, session, opts \\ [])

View Source
@spec get_checkout_sessions_session_line_items(
  client :: ExOAPI.Client.t(),
  session :: String.t(),
  [get_checkout_sessions_session_line_items_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>When retrieving a Checkout Session, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>

Link to this function

post_checkout_sessions(client, body)

View Source
@spec post_checkout_sessions(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates a Session object.</p>

Link to this function

post_checkout_sessions_session_expire(client, body, session)

View Source
@spec post_checkout_sessions_session_expire(
  client :: ExOAPI.Client.t(),
  body :: map(),
  session :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>A Session can be expired when it is in one of these statuses: <code>open</code> </p>

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.