Stripe.Params.Terminal.ReaderSetReaderDisplayParams (tiger_stripe v0.3.0)

Parameters for reader set reader display.

Summary

Types

cart()

cart_line_items()

t()

Types

cart()

@type cart() :: %{
  optional(:currency) => String.t() | nil,
  optional(:line_items) => [cart_line_items()] | nil,
  optional(:tax) => integer() | nil,
  optional(:total) => integer() | nil,
  optional(String.t()) => term()
}

currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.
line_items - Array of line items to display.
tax - The amount of tax in the smallest currency unit.
total - Total balance of cart due in the smallest currency unit.

cart_line_items()

@type cart_line_items() :: %{
  optional(:amount) => integer() | nil,
  optional(:description) => String.t() | nil,
  optional(:quantity) => integer() | nil,
  optional(String.t()) => term()
}

amount - The price of the item in the smallest currency unit.
description - The description or name of the item. Max length: 5000.
quantity - The quantity of the line item being purchased.

t()

@type t() :: %Stripe.Params.Terminal.ReaderSetReaderDisplayParams{
  cart: cart() | nil,
  expand: [String.t()] | nil,
  type: String.t()
}

cart - Cart details to display on the reader screen, including line items, amounts, and currency.
expand - Specifies which fields in the response should be expanded.
type - Type of information to display. Only cart is currently supported. Possible values: cart.