| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostInvoices
Description
Contains the different functions to run the operation postInvoices
Synopsis
- postInvoices :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostInvoicesRequestBody -> m (Either HttpException (Response PostInvoicesResponse))
- postInvoicesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostInvoicesRequestBody -> m (Either HttpException (Response ByteString))
- postInvoicesM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesResponse))
- postInvoicesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostInvoicesRequestBody = PostInvoicesRequestBody {
- postInvoicesRequestBodyApplicationFeeAmount :: Maybe Integer
- postInvoicesRequestBodyAutoAdvance :: Maybe Bool
- postInvoicesRequestBodyCollectionMethod :: Maybe PostInvoicesRequestBodyCollectionMethod'
- postInvoicesRequestBodyCustomFields :: Maybe PostInvoicesRequestBodyCustomFields'Variants
- postInvoicesRequestBodyCustomer :: Text
- postInvoicesRequestBodyDaysUntilDue :: Maybe Integer
- postInvoicesRequestBodyDefaultPaymentMethod :: Maybe Text
- postInvoicesRequestBodyDefaultSource :: Maybe Text
- postInvoicesRequestBodyDefaultTaxRates :: Maybe ([] Text)
- postInvoicesRequestBodyDescription :: Maybe Text
- postInvoicesRequestBodyDueDate :: Maybe Integer
- postInvoicesRequestBodyExpand :: Maybe ([] Text)
- postInvoicesRequestBodyFooter :: Maybe Text
- postInvoicesRequestBodyMetadata :: Maybe PostInvoicesRequestBodyMetadata'
- postInvoicesRequestBodyStatementDescriptor :: Maybe Text
- postInvoicesRequestBodySubscription :: Maybe Text
- postInvoicesRequestBodyTaxPercent :: Maybe Double
- data PostInvoicesRequestBodyCollectionMethod'
- data PostInvoicesRequestBodyCustomFields'OneOf1
- data PostInvoicesRequestBodyCustomFields'OneOf2 = PostInvoicesRequestBodyCustomFields'OneOf2 {}
- data PostInvoicesRequestBodyCustomFields'Variants
- data PostInvoicesRequestBodyMetadata' = PostInvoicesRequestBodyMetadata' {
- data PostInvoicesResponse
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> PostInvoicesRequestBody | The request body to send |
| -> m (Either HttpException (Response PostInvoicesResponse)) | Monad containing the result of the operation |
POST /v1/invoices
<p>This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations.</p>
postInvoicesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostInvoicesRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/invoices
The same as postInvoices but returns the raw ByteString
postInvoicesM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesResponse)) Source #
POST /v1/invoices
Monadic version of postInvoices (use with runWithConfiguration)
postInvoicesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostInvoicesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/invoices
Monadic version of postInvoicesRaw (use with runWithConfiguration)
data PostInvoicesRequestBody Source #
Defines the data type for the schema postInvoicesRequestBody
Constructors
| PostInvoicesRequestBody | |
Fields
| |
Instances
| Eq PostInvoicesRequestBody Source # | |
Defined in StripeAPI.Operations.PostInvoices Methods (==) :: PostInvoicesRequestBody -> PostInvoicesRequestBody -> Bool # (/=) :: PostInvoicesRequestBody -> PostInvoicesRequestBody -> Bool # | |
| Show PostInvoicesRequestBody Source # | |
Defined in StripeAPI.Operations.PostInvoices Methods showsPrec :: Int -> PostInvoicesRequestBody -> ShowS # show :: PostInvoicesRequestBody -> String # showList :: [PostInvoicesRequestBody] -> ShowS # | |
| ToJSON PostInvoicesRequestBody Source # | |
Defined in StripeAPI.Operations.PostInvoices Methods toJSON :: PostInvoicesRequestBody -> Value # toEncoding :: PostInvoicesRequestBody -> Encoding # toJSONList :: [PostInvoicesRequestBody] -> Value # | |
| FromJSON PostInvoicesRequestBody Source # | |
Defined in StripeAPI.Operations.PostInvoices Methods parseJSON :: Value -> Parser PostInvoicesRequestBody # parseJSONList :: Value -> Parser [PostInvoicesRequestBody] # | |
data PostInvoicesRequestBodyCollectionMethod' Source #
Defines the enum schema postInvoicesRequestBodyCollection_method'
Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.
Constructors
Instances
data PostInvoicesRequestBodyCustomFields'OneOf1 Source #
Defines the enum schema postInvoicesRequestBodyCustom_fields'OneOf1
Constructors
| PostInvoicesRequestBodyCustomFields'OneOf1EnumOther Value | |
| PostInvoicesRequestBodyCustomFields'OneOf1EnumTyped Text | |
| PostInvoicesRequestBodyCustomFields'OneOf1EnumString_ |
Instances
data PostInvoicesRequestBodyCustomFields'OneOf2 Source #
Defines the data type for the schema postInvoicesRequestBodyCustom_fields'OneOf2
Constructors
| PostInvoicesRequestBodyCustomFields'OneOf2 | |
Fields
| |
Instances
data PostInvoicesRequestBodyCustomFields'Variants Source #
Define the one-of schema postInvoicesRequestBodyCustom_fields'
A list of up to 4 custom fields to be displayed on the invoice.
Constructors
Instances
data PostInvoicesRequestBodyMetadata' Source #
Defines the data type for the schema postInvoicesRequestBodyMetadata'
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`.
Constructors
| PostInvoicesRequestBodyMetadata' | |
Instances
data PostInvoicesResponse Source #
Represents a response of the operation postInvoices.
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), PostInvoicesResponseError is used.
Constructors
| PostInvoicesResponseError String | Means either no matching case available or a parse error |
| PostInvoicesResponse200 Invoice | Successful response. |
| PostInvoicesResponseDefault Error | Error response. |
Instances
| Eq PostInvoicesResponse Source # | |
Defined in StripeAPI.Operations.PostInvoices Methods (==) :: PostInvoicesResponse -> PostInvoicesResponse -> Bool # (/=) :: PostInvoicesResponse -> PostInvoicesResponse -> Bool # | |
| Show PostInvoicesResponse Source # | |
Defined in StripeAPI.Operations.PostInvoices Methods showsPrec :: Int -> PostInvoicesResponse -> ShowS # show :: PostInvoicesResponse -> String # showList :: [PostInvoicesResponse] -> ShowS # | |