Search documentation of tiger_stripe

# Stripe.Resources.ShippingRate (tiger_stripe v0.1.1)

Copy Markdown View Source

ShippingRate

Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.

## Summary

### Types

t()

### Functions

expandable_fields()
object_name()

## Types

# t()

    @type t() :: %Stripe.Resources.ShippingRate{
      active: boolean(),
      created: integer(),
      delivery_estimate: map(),
      display_name: String.t(),
      fixed_amount: map() | nil,
      id: String.t(),
      livemode: boolean(),
      metadata: map(),
      object: String.t(),
      tax_behavior: String.t(),
      tax_code: String.t() | map(),
      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 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 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`.

## Functions

# expandable_fields()

# object_name()