StripeAPI.Types.ShippingMethod

Contains the types generated from the schema ShippingMethod

Documentation

data ShippingMethod

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

Constructors

ShippingMethod

Fields

• shippingMethodAmount :: Int

  amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item.

• shippingMethodCurrency :: Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• shippingMethodDeliveryEstimate :: Maybe ShippingMethodDeliveryEstimate'

  delivery_estimate: The estimated delivery date for the given shipping method. Can be either a specific date or a range.

• shippingMethodDescription :: Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• shippingMethodId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000

Instances

Eq ShippingMethod

Defined in StripeAPI.Types.ShippingMethod

Methods

(==) :: ShippingMethod -> ShippingMethod -> Bool

(/=) :: ShippingMethod -> ShippingMethod -> Bool

Show ShippingMethod

Defined in StripeAPI.Types.ShippingMethod

Methods

showsPrec :: Int -> ShippingMethod -> ShowS

show :: ShippingMethod -> String

showList :: [ShippingMethod] -> ShowS

ToJSON ShippingMethod

Defined in StripeAPI.Types.ShippingMethod

Methods

toJSON :: ShippingMethod -> Value

toEncoding :: ShippingMethod -> Encoding

toJSONList :: [ShippingMethod] -> Value

toEncodingList :: [ShippingMethod] -> Encoding

FromJSON ShippingMethod

Defined in StripeAPI.Types.ShippingMethod

Methods

parseJSON :: Value -> Parser ShippingMethod

parseJSONList :: Value -> Parser [ShippingMethod]

mkShippingMethod

Arguments

:: Int

shippingMethodAmount

-> Text

shippingMethodCurrency

-> Text

shippingMethodDescription

-> Text

shippingMethodId

-> ShippingMethod

Create a new ShippingMethod with all required fields.

data ShippingMethodDeliveryEstimate'

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

The estimated delivery date for the given shipping method. Can be either a specific date or a range.

Constructors

ShippingMethodDeliveryEstimate'

Fields

• shippingMethodDeliveryEstimate'Date :: Maybe Text

  date: If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD.

  Constraints:

  • Maximum length of 5000
• shippingMethodDeliveryEstimate'Earliest :: Maybe Text

  earliest: If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD.

  Constraints:

  • Maximum length of 5000
• shippingMethodDeliveryEstimate'Latest :: Maybe Text

  latest: If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD.

  Constraints:

  • Maximum length of 5000
• shippingMethodDeliveryEstimate'Type :: Maybe Text

  type: The type of estimate. Must be either `"range"` or `"exact"`.

  Constraints:

  • Maximum length of 5000

Instances

Eq ShippingMethodDeliveryEstimate'

Defined in StripeAPI.Types.ShippingMethod

Methods

(==) :: ShippingMethodDeliveryEstimate' -> ShippingMethodDeliveryEstimate' -> Bool

(/=) :: ShippingMethodDeliveryEstimate' -> ShippingMethodDeliveryEstimate' -> Bool

Show ShippingMethodDeliveryEstimate'

Defined in StripeAPI.Types.ShippingMethod

Methods

showsPrec :: Int -> ShippingMethodDeliveryEstimate' -> ShowS

show :: ShippingMethodDeliveryEstimate' -> String

showList :: [ShippingMethodDeliveryEstimate'] -> ShowS

ToJSON ShippingMethodDeliveryEstimate'

Defined in StripeAPI.Types.ShippingMethod

Methods

toJSON :: ShippingMethodDeliveryEstimate' -> Value

toEncoding :: ShippingMethodDeliveryEstimate' -> Encoding

toJSONList :: [ShippingMethodDeliveryEstimate'] -> Value

toEncodingList :: [ShippingMethodDeliveryEstimate'] -> Encoding

FromJSON ShippingMethodDeliveryEstimate'

Defined in StripeAPI.Types.ShippingMethod

Methods

parseJSON :: Value -> Parser ShippingMethodDeliveryEstimate'

parseJSONList :: Value -> Parser [ShippingMethodDeliveryEstimate']

mkShippingMethodDeliveryEstimate' :: ShippingMethodDeliveryEstimate'

Create a new ShippingMethodDeliveryEstimate' with all required fields.