Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostInvoicesInvoiceSend

Description

Contains the different functions to run the operation postInvoicesInvoiceSend

Synopsis

postInvoicesInvoiceSend :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceSendRequestBody -> m (Either HttpException (Response PostInvoicesInvoiceSendResponse))
postInvoicesInvoiceSendRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceSendRequestBody -> m (Either HttpException (Response ByteString))
postInvoicesInvoiceSendM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceSendRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceSendResponse))
postInvoicesInvoiceSendRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceSendRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostInvoicesInvoiceSendRequestBody = PostInvoicesInvoiceSendRequestBody {
- postInvoicesInvoiceSendRequestBodyExpand :: Maybe ([] Text)
}
data PostInvoicesInvoiceSendResponse

Documentation

postInvoicesInvoiceSend Source #

Arguments

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

POST /v1/invoices/{invoice}/send

<p>Stripe will automatically send invoices to customers according to your <a href="https://dashboard.stripe.com/account/billing/automatic">subscriptions settings</a>. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.</p>

<p>Requests made in test-mode result in no emails being sent, despite sending an <code>invoice.sent</code> event.</p>

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

POST /v1/invoices/{invoice}/send

The same as postInvoicesInvoiceSend but returns the raw ByteString

postInvoicesInvoiceSendM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceSendRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceSendResponse)) Source #

POST /v1/invoices/{invoice}/send

Monadic version of postInvoicesInvoiceSend (use with runWithConfiguration)

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

POST /v1/invoices/{invoice}/send

Monadic version of postInvoicesInvoiceSendRaw (use with runWithConfiguration)

data PostInvoicesInvoiceSendRequestBody Source #

Defines the data type for the schema postInvoicesInvoiceSendRequestBody

Constructors

PostInvoicesInvoiceSendRequestBody
Fields postInvoicesInvoiceSendRequestBodyExpand :: Maybe ([] Text) expand: Specifies which fields in the response should be expanded.

Instances

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

data PostInvoicesInvoiceSendResponse Source #

Represents a response of the operation postInvoicesInvoiceSend.

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

Constructors

PostInvoicesInvoiceSendResponseError String	Means either no matching case available or a parse error
PostInvoicesInvoiceSendResponse200 Invoice	Successful response.
PostInvoicesInvoiceSendResponseDefault Error	Error response.

Instances

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