Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.ShippingRate

Contains the types generated from the schema ShippingRate

8 types
4 values

Packagestripeapi-3.0.0.0
Exports12
LanguageHaskell2010
LicenceMIT
SourceShippingRate.hs

datadata ShippingRate

Defines the object schema located at components.schemas.shipping_rate in the specification.

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

Constructors

ShippingRate
- shippingRateActive :: Bool
  active: Whether the shipping rate can be used for new purchases. Defaults to `true`.
- shippingRateCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- shippingRateDeliveryEstimate :: Maybe (Nullable ShippingRateDeliveryEstimate'NonNullable)
  delivery_estimate: The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
- shippingRateDisplayName :: Maybe (Nullable Text)
  display_name: The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
  Constraints:
  - Maximum length of 5000
- shippingRateFixedAmount :: Maybe ShippingRateFixedAmount
  fixed_amount:
- shippingRateId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- shippingRateLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- shippingRateMetadata :: Object
  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.
- shippingRateTaxBehavior :: Maybe (Nullable ShippingRateTaxBehavior'NonNullable)
  tax_behavior: Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
- shippingRateTaxCode :: Maybe (Nullable ShippingRateTaxCode'NonNullableVariants)
  tax_code: A tax code ID. The Shipping tax code is `txcd_92010001`.

Instances4Eq, Show, FromJSON, ToJSON

Eq ShippingRateDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
Show ShippingRateDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
FromJSON ShippingRateDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
ToJSON ShippingRateDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate

valuemkShippingRate

:: Bool
shippingRateActive
-> Int
shippingRateCreated
-> Text
shippingRateId
-> Bool
shippingRateLivemode
-> Object
shippingRateMetadata
-> ShippingRate

Create a new ShippingRate with all required fields.

datadata ShippingRateDeliveryEstimate'NonNullable

Defines the object schema located at components.schemas.shipping_rate.properties.delivery_estimate.anyOf in the specification.

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

Constructors

ShippingRateDeliveryEstimate'NonNullable
- shippingRateDeliveryEstimate'NonNullableMaximum :: Maybe (Nullable ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullable)
  maximum: The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
- shippingRateDeliveryEstimate'NonNullableMinimum :: Maybe (Nullable ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullable)
  minimum: The lower bound of the estimated range. If empty, represents no lower bound.

Instances4Eq, Show, FromJSON, ToJSON

Eq ShippingRateDeliveryEstimate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
Show ShippingRateDeliveryEstimate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
FromJSON ShippingRateDeliveryEstimate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
ToJSON ShippingRateDeliveryEstimate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate

valuemkShippingRateDeliveryEstimate'NonNullable :: ShippingRateDeliveryEstimate'NonNullable

Create a new ShippingRateDeliveryEstimate'NonNullable with all required fields.

datadata ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullable

Defines the object schema located at components.schemas.shipping_rate.properties.delivery_estimate.anyOf.properties.maximum.anyOf in the specification.

The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.

Constructors

ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullable
- shippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit :: Maybe ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'
  unit: A unit of time.
- shippingRateDeliveryEstimate'NonNullableMaximum'NonNullableValue :: Maybe Int
  value: Must be greater than 0.

Instances4Eq, Show, FromJSON, ToJSON

Eq ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
Show ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
FromJSON ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
ToJSON ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate

value

mkShippingRateDeliveryEstimate'NonNullableMaximum'NonNullable :: ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullable

Create a new ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullable with all required fields.

datadata ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'

Defines the enum schema located at components.schemas.shipping_rate.properties.delivery_estimate.anyOf.properties.maximum.anyOf.properties.unit in the specification.

A unit of time.

Constructors

ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'EnumBusinessDay
Represents the JSON value "business_day"
ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'EnumDay
Represents the JSON value "day"
ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'EnumHour
Represents the JSON value "hour"
ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'EnumMonth
Represents the JSON value "month"
ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'EnumWeek
Represents the JSON value "week"

Instances4Eq, Show, FromJSON, ToJSON

Eq ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
Show ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
FromJSON ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
ToJSON ShippingRateDeliveryEstimate'NonNullableMaximum'NonNullableUnit'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate

datadata ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullable

Defines the object schema located at components.schemas.shipping_rate.properties.delivery_estimate.anyOf.properties.minimum.anyOf in the specification.

The lower bound of the estimated range. If empty, represents no lower bound.

Constructors

ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullable
- shippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit :: Maybe ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'
  unit: A unit of time.
- shippingRateDeliveryEstimate'NonNullableMinimum'NonNullableValue :: Maybe Int
  value: Must be greater than 0.

Instances4Eq, Show, FromJSON, ToJSON

Eq ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
Show ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
FromJSON ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
ToJSON ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate

value

mkShippingRateDeliveryEstimate'NonNullableMinimum'NonNullable :: ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullable

Create a new ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullable with all required fields.

datadata ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'

Defines the enum schema located at components.schemas.shipping_rate.properties.delivery_estimate.anyOf.properties.minimum.anyOf.properties.unit in the specification.

A unit of time.

Constructors

ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'EnumBusinessDay
Represents the JSON value "business_day"
ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'EnumDay
Represents the JSON value "day"
ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'EnumHour
Represents the JSON value "hour"
ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'EnumMonth
Represents the JSON value "month"
ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'EnumWeek
Represents the JSON value "week"

Instances4Eq, Show, FromJSON, ToJSON

Eq ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
Show ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
FromJSON ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
ToJSON ShippingRateDeliveryEstimate'NonNullableMinimum'NonNullableUnit'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate

datadata ShippingRateTaxBehavior'NonNullable

Defines the enum schema located at components.schemas.shipping_rate.properties.tax_behavior in the specification.

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

Constructors

ShippingRateTaxBehavior'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ShippingRateTaxBehavior'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
ShippingRateTaxBehavior'NonNullableEnumExclusive
Represents the JSON value "exclusive"
ShippingRateTaxBehavior'NonNullableEnumInclusive
Represents the JSON value "inclusive"
ShippingRateTaxBehavior'NonNullableEnumUnspecified
Represents the JSON value "unspecified"

Instances4Eq, Show, FromJSON, ToJSON

Eq ShippingRateTaxBehavior'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
Show ShippingRateTaxBehavior'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
FromJSON ShippingRateTaxBehavior'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
ToJSON ShippingRateTaxBehavior'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate

datadata ShippingRateTaxCode'NonNullableVariants

Defines the oneOf schema located at components.schemas.shipping_rate.properties.tax_code.anyOf in the specification.

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

Constructors

ShippingRateTaxCode'NonNullableText Text
ShippingRateTaxCode'NonNullableTaxCode TaxCode

Instances4Eq, Show, FromJSON, ToJSON

Eq ShippingRateTaxCode'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
Show ShippingRateTaxCode'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
FromJSON ShippingRateTaxCode'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate
ToJSON ShippingRateTaxCode'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ShippingRate