exoapi_stripe v0.1.4

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

description: Shipping rates describe the price of shipping presented to your customers and can be applied to Checkout Sessions to collect shipping costs.

:active :: :boolean

Whether the shipping rate can be used for new purchases. Defaults to true.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:delivery_estimate :: ExOAPI.Stripe.Schemas.ShippingRateDeliveryEstimate

The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

:display_name :: :string

The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

:fixed_amount :: ExOAPI.Stripe.Schemas.ShippingRateFixedAmount

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:object :: :string

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

:tax_behavior :: :string

Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

:tax_code :: ExOAPI.Stripe.Schemas.TaxCode | :string

A tax code ID. The Shipping tax code is txcd_92010001.

:type :: :string

The type of calculation to use on the shipping rate. Can only be fixed_amount for now.

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.ShippingRate{
  active: boolean() | nil,
  created: integer() | nil,
  delivery_estimate: ExOAPI.EctoTypes.AnyOf.t() | nil,
  display_name: String.t() | nil,
  fixed_amount: ExOAPI.Stripe.Schemas.ShippingRateFixedAmount.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :shipping_rate | nil,
  tax_behavior: (:unspecified | :inclusive | :exclusive) | nil,
  tax_code: ExOAPI.EctoTypes.AnyOf.t() | nil,
  type: :fixed_amount | nil
}

Link to this section Functions

Link to this function

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

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