Stripe.Params.ShippingRateUpdateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for shipping rate update.

Summary

Types

fixed_amount()
fixed_amount_currency_options()
t()

Types

fixed_amount()

@type fixed_amount() :: %{
  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.ShippingRateUpdateParams{
  active: boolean() | nil,
  expand: [String.t()] | nil,
  fixed_amount: fixed_amount() | nil,
  metadata: map() | nil,
  tax_behavior: String.t() | nil
}
  • active - Whether the shipping rate can be used for new purchases. Defaults to true.
  • 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.