# `Stripe.Resources.ShippingRate`
[🔗](https://github.com/jeffhuen/tiger_stripe/blob/main/lib/stripe/resources/shipping_rate.ex#L2)

ShippingRate

Shipping rates describe the price of shipping presented to your customers and
applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping).

# `delivery_estimate`

```elixir
@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. Nullable.
* `minimum` - The lower bound of the estimated range. If empty, represents no lower bound. Nullable.

# `delivery_estimate_maximum`

```elixir
@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`

```elixir
@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`

```elixir
@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()
}
```

* `amount` - A non-negative integer in cents representing how much to charge.
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `currency_options` - Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).

# `fixed_amount_currency_options`

```elixir
@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`

```elixir
@type t() :: %Stripe.Resources.ShippingRate{
  active: boolean(),
  created: integer(),
  delivery_estimate: delivery_estimate(),
  display_name: String.t(),
  fixed_amount: fixed_amount() | nil,
  id: String.t(),
  livemode: boolean(),
  metadata: %{required(String.t()) => String.t()},
  object: String.t(),
  tax_behavior: String.t(),
  tax_code: String.t() | Stripe.Resources.TaxCode.t(),
  type: String.t()
}
```

* `active` - Whether the shipping rate can be used for new purchases. Defaults to `true`.
* `created` - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
* `delivery_estimate` - The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. Nullable. Expandable.
* `display_name` - The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. Max length: 5000. Nullable.
* `fixed_amount` - Expandable.
* `id` - Unique identifier for the object. Max length: 5000.
* `livemode` - Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
* `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `shipping_rate`.
* `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`. Nullable.
* `tax_code` - A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. Nullable. Expandable.
* `type` - The type of calculation to use on the shipping rate. Possible values: `fixed_amount`.

# `expandable_fields`

# `object_name`

---

*Consult [api-reference.md](api-reference.md) for complete listing*