Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostPaymentMethodsPaymentMethodAttach

Description

Contains the different functions to run the operation postPaymentMethodsPaymentMethodAttach

Synopsis

postPaymentMethodsPaymentMethodAttach :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> PostPaymentMethodsPaymentMethodAttachRequestBody -> m (Either HttpException (Response PostPaymentMethodsPaymentMethodAttachResponse))
postPaymentMethodsPaymentMethodAttachRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> PostPaymentMethodsPaymentMethodAttachRequestBody -> m (Either HttpException (Response ByteString))
postPaymentMethodsPaymentMethodAttachM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostPaymentMethodsPaymentMethodAttachRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentMethodsPaymentMethodAttachResponse))
postPaymentMethodsPaymentMethodAttachRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostPaymentMethodsPaymentMethodAttachRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostPaymentMethodsPaymentMethodAttachRequestBody = PostPaymentMethodsPaymentMethodAttachRequestBody {
- postPaymentMethodsPaymentMethodAttachRequestBodyCustomer :: Text
- postPaymentMethodsPaymentMethodAttachRequestBodyExpand :: Maybe ([] Text)
}
data PostPaymentMethodsPaymentMethodAttachResponse

Documentation

postPaymentMethodsPaymentMethodAttach Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	payment_method \| Constraints: Maximum length of 5000
-> PostPaymentMethodsPaymentMethodAttachRequestBody	The request body to send
-> m (Either HttpException (Response PostPaymentMethodsPaymentMethodAttachResponse))	Monad containing the result of the operation

POST /v1/payment_methods/{payment_method}/attach

<p>Attaches a PaymentMethod object to a Customer.</p>

<p>To use this PaymentMethod as the default for invoice or subscription payments, set <a href="/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"><code>invoice_settings.default_payment_method</code></a>, on the Customer to the PaymentMethod’s ID.</p>

postPaymentMethodsPaymentMethodAttachRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> PostPaymentMethodsPaymentMethodAttachRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/payment_methods/{payment_method}/attach

The same as postPaymentMethodsPaymentMethodAttach but returns the raw ByteString

postPaymentMethodsPaymentMethodAttachM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostPaymentMethodsPaymentMethodAttachRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentMethodsPaymentMethodAttachResponse)) Source #

POST /v1/payment_methods/{payment_method}/attach

Monadic version of postPaymentMethodsPaymentMethodAttach (use with runWithConfiguration)

postPaymentMethodsPaymentMethodAttachRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> PostPaymentMethodsPaymentMethodAttachRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/payment_methods/{payment_method}/attach

Monadic version of postPaymentMethodsPaymentMethodAttachRaw (use with runWithConfiguration)

data PostPaymentMethodsPaymentMethodAttachRequestBody Source #

Defines the data type for the schema postPaymentMethodsPaymentMethodAttachRequestBody

Constructors

PostPaymentMethodsPaymentMethodAttachRequestBody
Fields postPaymentMethodsPaymentMethodAttachRequestBodyCustomer :: Text customer: The ID of the customer to which to attach the PaymentMethod. Constraints: Maximum length of 5000 postPaymentMethodsPaymentMethodAttachRequestBodyExpand :: Maybe ([] Text) expand: Specifies which fields in the response should be expanded.

Instances

Eq PostPaymentMethodsPaymentMethodAttachRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPaymentMethodsPaymentMethodAttach Methods (==) :: PostPaymentMethodsPaymentMethodAttachRequestBody -> PostPaymentMethodsPaymentMethodAttachRequestBody -> Bool # (/=) :: PostPaymentMethodsPaymentMethodAttachRequestBody -> PostPaymentMethodsPaymentMethodAttachRequestBody -> Bool #
Show PostPaymentMethodsPaymentMethodAttachRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPaymentMethodsPaymentMethodAttach Methods showsPrec :: Int -> PostPaymentMethodsPaymentMethodAttachRequestBody -> ShowS # show :: PostPaymentMethodsPaymentMethodAttachRequestBody -> String # showList :: [PostPaymentMethodsPaymentMethodAttachRequestBody] -> ShowS #
ToJSON PostPaymentMethodsPaymentMethodAttachRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPaymentMethodsPaymentMethodAttach Methods toJSON :: PostPaymentMethodsPaymentMethodAttachRequestBody -> Value # toEncoding :: PostPaymentMethodsPaymentMethodAttachRequestBody -> Encoding # toJSONList :: [PostPaymentMethodsPaymentMethodAttachRequestBody] -> Value # toEncodingList :: [PostPaymentMethodsPaymentMethodAttachRequestBody] -> Encoding #
FromJSON PostPaymentMethodsPaymentMethodAttachRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPaymentMethodsPaymentMethodAttach Methods parseJSON :: Value -> Parser PostPaymentMethodsPaymentMethodAttachRequestBody # parseJSONList :: Value -> Parser [PostPaymentMethodsPaymentMethodAttachRequestBody] #

data PostPaymentMethodsPaymentMethodAttachResponse Source #

Represents a response of the operation postPaymentMethodsPaymentMethodAttach.

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), PostPaymentMethodsPaymentMethodAttachResponseError is used.

Constructors

PostPaymentMethodsPaymentMethodAttachResponseError String	Means either no matching case available or a parse error
PostPaymentMethodsPaymentMethodAttachResponse200 PaymentMethod	Successful response.
PostPaymentMethodsPaymentMethodAttachResponseDefault Error	Error response.

Instances

Eq PostPaymentMethodsPaymentMethodAttachResponse Source #
Instance details Defined in StripeAPI.Operations.PostPaymentMethodsPaymentMethodAttach Methods (==) :: PostPaymentMethodsPaymentMethodAttachResponse -> PostPaymentMethodsPaymentMethodAttachResponse -> Bool # (/=) :: PostPaymentMethodsPaymentMethodAttachResponse -> PostPaymentMethodsPaymentMethodAttachResponse -> Bool #
Show PostPaymentMethodsPaymentMethodAttachResponse Source #
Instance details Defined in StripeAPI.Operations.PostPaymentMethodsPaymentMethodAttach Methods showsPrec :: Int -> PostPaymentMethodsPaymentMethodAttachResponse -> ShowS # show :: PostPaymentMethodsPaymentMethodAttachResponse -> String # showList :: [PostPaymentMethodsPaymentMethodAttachResponse] -> ShowS #