Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postCheckoutSessions
Synopsis
- postCheckoutSessions :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostCheckoutSessionsRequestBody -> m (Either HttpException (Response PostCheckoutSessionsResponse))
- postCheckoutSessionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostCheckoutSessionsRequestBody -> m (Either HttpException (Response ByteString))
- postCheckoutSessionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCheckoutSessionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCheckoutSessionsResponse))
- postCheckoutSessionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCheckoutSessionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostCheckoutSessionsRequestBody = PostCheckoutSessionsRequestBody {
- postCheckoutSessionsRequestBodyBillingAddressCollection :: Maybe PostCheckoutSessionsRequestBodyBillingAddressCollection'
- postCheckoutSessionsRequestBodyCancelUrl :: Text
- postCheckoutSessionsRequestBodyClientReferenceId :: Maybe Text
- postCheckoutSessionsRequestBodyCustomer :: Maybe Text
- postCheckoutSessionsRequestBodyCustomerEmail :: Maybe Text
- postCheckoutSessionsRequestBodyExpand :: Maybe ([] Text)
- postCheckoutSessionsRequestBodyLineItems :: Maybe ([] PostCheckoutSessionsRequestBodyLineItems')
- postCheckoutSessionsRequestBodyLocale :: Maybe PostCheckoutSessionsRequestBodyLocale'
- postCheckoutSessionsRequestBodyMetadata :: Maybe PostCheckoutSessionsRequestBodyMetadata'
- postCheckoutSessionsRequestBodyMode :: Maybe PostCheckoutSessionsRequestBodyMode'
- postCheckoutSessionsRequestBodyPaymentIntentData :: Maybe PostCheckoutSessionsRequestBodyPaymentIntentData'
- postCheckoutSessionsRequestBodyPaymentMethodTypes :: [] PostCheckoutSessionsRequestBodyPaymentMethodTypes'
- postCheckoutSessionsRequestBodySetupIntentData :: Maybe PostCheckoutSessionsRequestBodySetupIntentData'
- postCheckoutSessionsRequestBodySubmitType :: Maybe PostCheckoutSessionsRequestBodySubmitType'
- postCheckoutSessionsRequestBodySubscriptionData :: Maybe PostCheckoutSessionsRequestBodySubscriptionData'
- postCheckoutSessionsRequestBodySuccessUrl :: Text
- data PostCheckoutSessionsRequestBodyBillingAddressCollection'
- data PostCheckoutSessionsRequestBodyLineItems' = PostCheckoutSessionsRequestBodyLineItems' {
- postCheckoutSessionsRequestBodyLineItems'Amount :: Maybe Integer
- postCheckoutSessionsRequestBodyLineItems'Currency :: Maybe Text
- postCheckoutSessionsRequestBodyLineItems'Description :: Maybe Text
- postCheckoutSessionsRequestBodyLineItems'Images :: Maybe ([] Text)
- postCheckoutSessionsRequestBodyLineItems'Name :: Maybe Text
- postCheckoutSessionsRequestBodyLineItems'Quantity :: Integer
- postCheckoutSessionsRequestBodyLineItems'TaxRates :: Maybe ([] Text)
- data PostCheckoutSessionsRequestBodyLocale'
- = PostCheckoutSessionsRequestBodyLocale'EnumOther Value
- | PostCheckoutSessionsRequestBodyLocale'EnumTyped Text
- | PostCheckoutSessionsRequestBodyLocale'EnumStringAuto
- | PostCheckoutSessionsRequestBodyLocale'EnumStringDa
- | PostCheckoutSessionsRequestBodyLocale'EnumStringDe
- | PostCheckoutSessionsRequestBodyLocale'EnumStringEn
- | PostCheckoutSessionsRequestBodyLocale'EnumStringEs
- | PostCheckoutSessionsRequestBodyLocale'EnumStringFi
- | PostCheckoutSessionsRequestBodyLocale'EnumStringFr
- | PostCheckoutSessionsRequestBodyLocale'EnumStringIt
- | PostCheckoutSessionsRequestBodyLocale'EnumStringJa
- | PostCheckoutSessionsRequestBodyLocale'EnumStringMs
- | PostCheckoutSessionsRequestBodyLocale'EnumStringNb
- | PostCheckoutSessionsRequestBodyLocale'EnumStringNl
- | PostCheckoutSessionsRequestBodyLocale'EnumStringPl
- | PostCheckoutSessionsRequestBodyLocale'EnumStringPt
- | PostCheckoutSessionsRequestBodyLocale'EnumStringSv
- | PostCheckoutSessionsRequestBodyLocale'EnumStringZh
- data PostCheckoutSessionsRequestBodyMetadata' = PostCheckoutSessionsRequestBodyMetadata' {
- data PostCheckoutSessionsRequestBodyMode'
- data PostCheckoutSessionsRequestBodyPaymentIntentData' = PostCheckoutSessionsRequestBodyPaymentIntentData' {
- postCheckoutSessionsRequestBodyPaymentIntentData'ApplicationFeeAmount :: Maybe Integer
- postCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod :: Maybe PostCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod'
- postCheckoutSessionsRequestBodyPaymentIntentData'Description :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Metadata :: Maybe PostCheckoutSessionsRequestBodyPaymentIntentData'Metadata'
- postCheckoutSessionsRequestBodyPaymentIntentData'OnBehalfOf :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'ReceiptEmail :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage :: Maybe PostCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage'
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping :: Maybe PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping'
- postCheckoutSessionsRequestBodyPaymentIntentData'StatementDescriptor :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'StatementDescriptorSuffix :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'TransferData :: Maybe PostCheckoutSessionsRequestBodyPaymentIntentData'TransferData'
- data PostCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod'
- = PostCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod'EnumOther Value
- | PostCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod'EnumTyped Text
- | PostCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod'EnumStringAutomatic
- | PostCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod'EnumStringManual
- data PostCheckoutSessionsRequestBodyPaymentIntentData'Metadata' = PostCheckoutSessionsRequestBodyPaymentIntentData'Metadata' {
- data PostCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage'
- = PostCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage'EnumOther Value
- | PostCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage'EnumTyped Text
- | PostCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage'EnumStringOffSession
- | PostCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage'EnumStringOnSession
- data PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping' = PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping' {
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address :: PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address'
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Carrier :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Name :: Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Phone :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'TrackingNumber :: Maybe Text
- data PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address' = PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address' {
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address'City :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address'Country :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address'Line1 :: Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address'Line2 :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address'PostalCode :: Maybe Text
- postCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address'State :: Maybe Text
- data PostCheckoutSessionsRequestBodyPaymentIntentData'TransferData' = PostCheckoutSessionsRequestBodyPaymentIntentData'TransferData' {}
- data PostCheckoutSessionsRequestBodyPaymentMethodTypes'
- = PostCheckoutSessionsRequestBodyPaymentMethodTypes'EnumOther Value
- | PostCheckoutSessionsRequestBodyPaymentMethodTypes'EnumTyped Text
- | PostCheckoutSessionsRequestBodyPaymentMethodTypes'EnumStringCard
- | PostCheckoutSessionsRequestBodyPaymentMethodTypes'EnumStringFpx
- | PostCheckoutSessionsRequestBodyPaymentMethodTypes'EnumStringIdeal
- data PostCheckoutSessionsRequestBodySetupIntentData' = PostCheckoutSessionsRequestBodySetupIntentData' {}
- data PostCheckoutSessionsRequestBodySetupIntentData'Metadata' = PostCheckoutSessionsRequestBodySetupIntentData'Metadata' {
- data PostCheckoutSessionsRequestBodySubmitType'
- = PostCheckoutSessionsRequestBodySubmitType'EnumOther Value
- | PostCheckoutSessionsRequestBodySubmitType'EnumTyped Text
- | PostCheckoutSessionsRequestBodySubmitType'EnumStringAuto
- | PostCheckoutSessionsRequestBodySubmitType'EnumStringBook
- | PostCheckoutSessionsRequestBodySubmitType'EnumStringDonate
- | PostCheckoutSessionsRequestBodySubmitType'EnumStringPay
- data PostCheckoutSessionsRequestBodySubscriptionData' = PostCheckoutSessionsRequestBodySubscriptionData' {
- postCheckoutSessionsRequestBodySubscriptionData'ApplicationFeePercent :: Maybe Double
- postCheckoutSessionsRequestBodySubscriptionData'DefaultTaxRates :: Maybe ([] Text)
- postCheckoutSessionsRequestBodySubscriptionData'Items :: Maybe ([] PostCheckoutSessionsRequestBodySubscriptionData'Items')
- postCheckoutSessionsRequestBodySubscriptionData'Metadata :: Maybe PostCheckoutSessionsRequestBodySubscriptionData'Metadata'
- postCheckoutSessionsRequestBodySubscriptionData'TrialEnd :: Maybe Integer
- postCheckoutSessionsRequestBodySubscriptionData'TrialFromPlan :: Maybe Bool
- postCheckoutSessionsRequestBodySubscriptionData'TrialPeriodDays :: Maybe Integer
- data PostCheckoutSessionsRequestBodySubscriptionData'Items' = PostCheckoutSessionsRequestBodySubscriptionData'Items' {}
- data PostCheckoutSessionsRequestBodySubscriptionData'Metadata' = PostCheckoutSessionsRequestBodySubscriptionData'Metadata' {
- data PostCheckoutSessionsResponse
Documentation
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> PostCheckoutSessionsRequestBody | The request body to send |
-> m (Either HttpException (Response PostCheckoutSessionsResponse)) | Monad containing the result of the operation |
POST /v1/checkout/sessions
<p>Creates a Session object.</p>
postCheckoutSessionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostCheckoutSessionsRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/checkout/sessions
The same as postCheckoutSessions
but returns the raw ByteString
postCheckoutSessionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCheckoutSessionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCheckoutSessionsResponse)) Source #
POST /v1/checkout/sessions
Monadic version of postCheckoutSessions
(use with runWithConfiguration
)
postCheckoutSessionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostCheckoutSessionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/checkout/sessions
Monadic version of postCheckoutSessionsRaw
(use with runWithConfiguration
)
data PostCheckoutSessionsRequestBody Source #
Defines the data type for the schema postCheckoutSessionsRequestBody
PostCheckoutSessionsRequestBody | |
|
data PostCheckoutSessionsRequestBodyBillingAddressCollection' Source #
Defines the enum schema postCheckoutSessionsRequestBodyBilling_address_collection'
Specify whether Checkout should collect the customer's billing address.
Instances
data PostCheckoutSessionsRequestBodyLineItems' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodyLine_items'
PostCheckoutSessionsRequestBodyLineItems' | |
|
data PostCheckoutSessionsRequestBodyLocale' Source #
Defines the enum schema postCheckoutSessionsRequestBodyLocale'
The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
data PostCheckoutSessionsRequestBodyMetadata' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodyMetadata'
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`.
data PostCheckoutSessionsRequestBodyMode' Source #
Defines the enum schema postCheckoutSessionsRequestBodyMode'
The mode of the Checkout Session, one of `payment`, `setup`, or `subscription`.
data PostCheckoutSessionsRequestBodyPaymentIntentData' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodyPayment_intent_data'
A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
Instances
data PostCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod' Source #
Defines the enum schema postCheckoutSessionsRequestBodyPayment_intent_data'Capture_method'
Instances
data PostCheckoutSessionsRequestBodyPaymentIntentData'Metadata' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodyPayment_intent_data'Metadata'
Instances
data PostCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage' Source #
Defines the enum schema postCheckoutSessionsRequestBodyPayment_intent_data'Setup_future_usage'
Instances
data PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodyPayment_intent_data'Shipping'
PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping' | |
|
Instances
data PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodyPayment_intent_data'Shipping'Address'
PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address' | |
|
Instances
data PostCheckoutSessionsRequestBodyPaymentIntentData'TransferData' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodyPayment_intent_data'Transfer_data'
Instances
data PostCheckoutSessionsRequestBodyPaymentMethodTypes' Source #
Defines the enum schema postCheckoutSessionsRequestBodyPayment_method_types'
Instances
data PostCheckoutSessionsRequestBodySetupIntentData' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodySetup_intent_data'
A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
PostCheckoutSessionsRequestBodySetupIntentData' | |
|
Instances
data PostCheckoutSessionsRequestBodySetupIntentData'Metadata' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodySetup_intent_data'Metadata'
Instances
data PostCheckoutSessionsRequestBodySubmitType' Source #
Defines the enum schema postCheckoutSessionsRequestBodySubmit_type'
Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. `submit_type` can only be specified on Checkout Sessions in `payment` mode, but not Checkout Sessions in `subscription` or `setup` mode.
data PostCheckoutSessionsRequestBodySubscriptionData' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodySubscription_data'
A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
Instances
data PostCheckoutSessionsRequestBodySubscriptionData'Items' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodySubscription_data'Items'
PostCheckoutSessionsRequestBodySubscriptionData'Items' | |
|
Instances
data PostCheckoutSessionsRequestBodySubscriptionData'Metadata' Source #
Defines the data type for the schema postCheckoutSessionsRequestBodySubscription_data'Metadata'
Instances
data PostCheckoutSessionsResponse Source #
Represents a response of the operation postCheckoutSessions
.
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), PostCheckoutSessionsResponseError
is used.
PostCheckoutSessionsResponseError String | Means either no matching case available or a parse error |
PostCheckoutSessionsResponse200 Checkout'session | Successful response. |
PostCheckoutSessionsResponseDefault Error | Error response. |