Stripe.Params.ShippingRateCreateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for shipping rate create.

Summary

Types

delivery_estimate()
delivery_estimate_maximum()
delivery_estimate_minimum()
fixed_amount()
fixed_amount_currency_options()
t()

Types

delivery_estimate()

@type delivery_estimate() :: %{
  optional(:maximum) => delivery_estimate_maximum() | nil,
  optional(:minimum) => delivery_estimate_minimum() | nil,
  optional(String.t()) => term()
}
  • maximum - The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
  • minimum - The lower bound of the estimated range. If empty, represents no lower bound.

delivery_estimate_maximum()

@type delivery_estimate_maximum() :: %{
  optional(:unit) => String.t() | nil,
  optional(:value) => integer() | nil,
  optional(String.t()) => term()
}
  • unit - A unit of time. Possible values: business_day, day, hour, month, week.
  • value - Must be greater than 0.

delivery_estimate_minimum()

@type delivery_estimate_minimum() :: %{
  optional(:unit) => String.t() | nil,
  optional(:value) => integer() | nil,
  optional(String.t()) => term()
}
  • unit - A unit of time. Possible values: business_day, day, hour, month, week.
  • value - Must be greater than 0.

fixed_amount()

@type fixed_amount() :: %{
  optional(:amount) => integer() | nil,
  optional(:currency) => String.t() | nil,
  optional(:currency_options) =>
    %{required(String.t()) => fixed_amount_currency_options()} | nil,
  optional(String.t()) => term()
}

fixed_amount_currency_options()

@type fixed_amount_currency_options() :: %{
  optional(:amount) => integer() | nil,
  optional(:tax_behavior) => String.t() | nil,
  optional(String.t()) => term()
}
  • amount - A non-negative integer in cents representing how much to charge.
  • tax_behavior - Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Possible values: exclusive, inclusive, unspecified.

t()

@type t() :: %Stripe.Params.ShippingRateCreateParams{
  delivery_estimate: delivery_estimate() | nil,
  display_name: String.t(),
  expand: [String.t()] | nil,
  fixed_amount: fixed_amount() | nil,
  metadata: %{required(String.t()) => String.t()} | nil,
  tax_behavior: String.t() | nil,
  tax_code: String.t() | nil,
  type: String.t() | nil
}
  • delivery_estimate - The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
  • display_name - The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. Max length: 100.
  • expand - Specifies which fields in the response should be expanded.
  • fixed_amount - Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
  • metadata - 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
  • tax_behavior - Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Possible values: exclusive, inclusive, unspecified.
  • tax_code - A tax code ID. The Shipping tax code is txcd_92010001.
  • type - The type of calculation to use on the shipping rate. Possible values: fixed_amount.