exoapi_stripe v0.1.4

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

description: A representation of the constituent items of any given order. Can be used to represent SKUs, shipping costs, or taxes owed on the order.

Related guide: Orders.

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

:currency :: :string

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

:description :: :string

Description of the line item, meant to be displayable to the user (e.g., "Express shipping").

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:parent :: ExOAPI.Stripe.Schemas.Sku | :string

The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).

:quantity :: :integer

A positive integer representing the number of instances of parent that are included in this order item. Applicable/present only if type is sku.

:type :: :string

The type of line item. One of sku, tax, shipping, or discount.

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.OrderItem{
  amount: integer() | nil,
  currency: String.t() | nil,
  description: String.t() | nil,
  object: :order_item | nil,
  parent: ExOAPI.EctoTypes.AnyOf.t() | nil,
  quantity: integer() | nil,
  type: String.t() | nil
}

Link to this section Functions

Link to this function

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

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