Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostShippingRates

Contains the different functions to run the operation postShippingRates

10 types
6 values

Packagestripeapi-3.0.0.0
Exports16
LanguageHaskell2010
LicenceMIT
SourcePostShippingRates.hs

valuepostShippingRates

:: MonadHTTP m
=> PostShippingRatesRequestBody
The request body to send
-> ClientT m (Response PostShippingRatesResponse)
Monadic computation which returns the result of the operation

POST /v1/shipping_rates

<p>Creates a new shipping rate object.</p>

datadata PostShippingRatesRequestBody

Defines the object schema located at paths./v1/shipping_rates.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostShippingRatesRequestBody
- postShippingRatesRequestBodyDeliveryEstimate :: Maybe PostShippingRatesRequestBodyDeliveryEstimate'
  delivery_estimate: The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
- postShippingRatesRequestBodyDisplayName :: 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 100
- postShippingRatesRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postShippingRatesRequestBodyFixedAmount :: Maybe PostShippingRatesRequestBodyFixedAmount'
  fixed_amount: Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
- postShippingRatesRequestBodyMetadata :: Maybe 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
- postShippingRatesRequestBodyTaxBehavior :: Maybe PostShippingRatesRequestBodyTaxBehavior'
  tax_behavior: Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
- postShippingRatesRequestBodyTaxCode :: Maybe Text
  tax_code: A tax code ID. The Shipping tax code is `txcd_92010001`.
- postShippingRatesRequestBodyType :: Maybe PostShippingRatesRequestBodyType'
  type: The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

valuemkPostShippingRatesRequestBody

:: Text
postShippingRatesRequestBodyDisplayName
-> PostShippingRatesRequestBody

Create a new PostShippingRatesRequestBody with all required fields.

datadata PostShippingRatesRequestBodyDeliveryEstimate'

Defines the object schema located at paths./v1/shipping_rates.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.delivery_estimate 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

PostShippingRatesRequestBodyDeliveryEstimate'
- postShippingRatesRequestBodyDeliveryEstimate'Maximum :: Maybe PostShippingRatesRequestBodyDeliveryEstimate'Maximum'
  maximum
- postShippingRatesRequestBodyDeliveryEstimate'Minimum :: Maybe PostShippingRatesRequestBodyDeliveryEstimate'Minimum'
  minimum

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyDeliveryEstimate'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyDeliveryEstimate'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyDeliveryEstimate'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyDeliveryEstimate'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

valuemkPostShippingRatesRequestBodyDeliveryEstimate' :: PostShippingRatesRequestBodyDeliveryEstimate'

Create a new PostShippingRatesRequestBodyDeliveryEstimate' with all required fields.

datadata PostShippingRatesRequestBodyDeliveryEstimate'Maximum'

Defines the object schema located at paths./v1/shipping_rates.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.delivery_estimate.properties.maximum in the specification.

Constructors

PostShippingRatesRequestBodyDeliveryEstimate'Maximum'
- postShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit :: PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit'
  unit
- postShippingRatesRequestBodyDeliveryEstimate'Maximum'Value :: Int
  value

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

valuemkPostShippingRatesRequestBodyDeliveryEstimate'Maximum'

:: PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit'
postShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit
-> Int
postShippingRatesRequestBodyDeliveryEstimate'Maximum'Value
-> PostShippingRatesRequestBodyDeliveryEstimate'Maximum'

Create a new PostShippingRatesRequestBodyDeliveryEstimate'Maximum' with all required fields.

datadata PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit'

Defines the enum schema located at paths./v1/shipping_rates.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.delivery_estimate.properties.maximum.properties.unit in the specification.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyDeliveryEstimate'Maximum'Unit'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

datadata PostShippingRatesRequestBodyDeliveryEstimate'Minimum'

Defines the object schema located at paths./v1/shipping_rates.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.delivery_estimate.properties.minimum in the specification.

Constructors

PostShippingRatesRequestBodyDeliveryEstimate'Minimum'
- postShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit :: PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit'
  unit
- postShippingRatesRequestBodyDeliveryEstimate'Minimum'Value :: Int
  value

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

valuemkPostShippingRatesRequestBodyDeliveryEstimate'Minimum'

:: PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit'
postShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit
-> Int
postShippingRatesRequestBodyDeliveryEstimate'Minimum'Value
-> PostShippingRatesRequestBodyDeliveryEstimate'Minimum'

Create a new PostShippingRatesRequestBodyDeliveryEstimate'Minimum' with all required fields.

datadata PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit'

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyDeliveryEstimate'Minimum'Unit'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

datadata PostShippingRatesRequestBodyFixedAmount'

Defines the object schema located at paths./v1/shipping_rates.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.fixed_amount in the specification.

Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.

Constructors

PostShippingRatesRequestBodyFixedAmount'
- postShippingRatesRequestBodyFixedAmount'Amount :: Int
  amount
- postShippingRatesRequestBodyFixedAmount'Currency :: Text
  currency

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyFixedAmount'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyFixedAmount'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyFixedAmount'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyFixedAmount'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

valuemkPostShippingRatesRequestBodyFixedAmount'

:: Int
postShippingRatesRequestBodyFixedAmount'Amount
-> Text
postShippingRatesRequestBodyFixedAmount'Currency
-> PostShippingRatesRequestBodyFixedAmount'

Create a new PostShippingRatesRequestBodyFixedAmount' with all required fields.

datadata PostShippingRatesRequestBodyTaxBehavior'

Defines the enum schema located at paths./v1/shipping_rates.POST.requestBody.content.application/x-www-form-urlencoded.schema.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

PostShippingRatesRequestBodyTaxBehavior'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostShippingRatesRequestBodyTaxBehavior'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostShippingRatesRequestBodyTaxBehavior'EnumExclusive
Represents the JSON value "exclusive"
PostShippingRatesRequestBodyTaxBehavior'EnumInclusive
Represents the JSON value "inclusive"
PostShippingRatesRequestBodyTaxBehavior'EnumUnspecified
Represents the JSON value "unspecified"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyTaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyTaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyTaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyTaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

datadata PostShippingRatesRequestBodyType'

Defines the enum schema located at paths./v1/shipping_rates.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.type in the specification.

The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.

Constructors

PostShippingRatesRequestBodyType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostShippingRatesRequestBodyType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostShippingRatesRequestBodyType'EnumFixedAmount
Represents the JSON value "fixed_amount"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostShippingRatesRequestBodyType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesRequestBodyType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
FromJSON PostShippingRatesRequestBodyType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
ToJSON PostShippingRatesRequestBodyType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates

datadata PostShippingRatesResponse

Represents a response of the operation postShippingRates.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostShippingRatesResponseError is used.

Constructors

PostShippingRatesResponseError String
Means either no matching case available or a parse error
PostShippingRatesResponse200 ShippingRate
Successful response.
PostShippingRatesResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostShippingRatesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates
Show PostShippingRatesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostShippingRates