| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostInvoices
Description
Contains the different functions to run the operation postInvoices
Synopsis
- postInvoices :: forall m. MonadHTTP m => PostInvoicesRequestBody -> ClientT m (Response PostInvoicesResponse)
- data PostInvoicesRequestBody = PostInvoicesRequestBody {
- postInvoicesRequestBodyAccountTaxIds :: Maybe PostInvoicesRequestBodyAccountTaxIds'Variants
- postInvoicesRequestBodyApplicationFeeAmount :: Maybe Int
- postInvoicesRequestBodyAutoAdvance :: Maybe Bool
- postInvoicesRequestBodyAutomaticTax :: Maybe PostInvoicesRequestBodyAutomaticTax'
- postInvoicesRequestBodyCollectionMethod :: Maybe PostInvoicesRequestBodyCollectionMethod'
- postInvoicesRequestBodyCustomFields :: Maybe PostInvoicesRequestBodyCustomFields'Variants
- postInvoicesRequestBodyCustomer :: Text
- postInvoicesRequestBodyDaysUntilDue :: Maybe Int
- postInvoicesRequestBodyDefaultPaymentMethod :: Maybe Text
- postInvoicesRequestBodyDefaultSource :: Maybe Text
- postInvoicesRequestBodyDefaultTaxRates :: Maybe [Text]
- postInvoicesRequestBodyDescription :: Maybe Text
- postInvoicesRequestBodyDiscounts :: Maybe PostInvoicesRequestBodyDiscounts'Variants
- postInvoicesRequestBodyDueDate :: Maybe Int
- postInvoicesRequestBodyExpand :: Maybe [Text]
- postInvoicesRequestBodyFooter :: Maybe Text
- postInvoicesRequestBodyMetadata :: Maybe PostInvoicesRequestBodyMetadata'Variants
- postInvoicesRequestBodyOnBehalfOf :: Maybe Text
- postInvoicesRequestBodyPaymentSettings :: Maybe PostInvoicesRequestBodyPaymentSettings'
- postInvoicesRequestBodyStatementDescriptor :: Maybe Text
- postInvoicesRequestBodySubscription :: Maybe Text
- postInvoicesRequestBodyTransferData :: Maybe PostInvoicesRequestBodyTransferData'
- mkPostInvoicesRequestBody :: Text -> PostInvoicesRequestBody
- data PostInvoicesRequestBodyAccountTaxIds'Variants
- data PostInvoicesRequestBodyAutomaticTax' = PostInvoicesRequestBodyAutomaticTax' {}
- mkPostInvoicesRequestBodyAutomaticTax' :: Bool -> PostInvoicesRequestBodyAutomaticTax'
- data PostInvoicesRequestBodyCollectionMethod'
- data PostInvoicesRequestBodyCustomFields'OneOf1 = PostInvoicesRequestBodyCustomFields'OneOf1 {}
- mkPostInvoicesRequestBodyCustomFields'OneOf1 :: Text -> Text -> PostInvoicesRequestBodyCustomFields'OneOf1
- data PostInvoicesRequestBodyCustomFields'Variants
- data PostInvoicesRequestBodyDiscounts'OneOf1 = PostInvoicesRequestBodyDiscounts'OneOf1 {}
- mkPostInvoicesRequestBodyDiscounts'OneOf1 :: PostInvoicesRequestBodyDiscounts'OneOf1
- data PostInvoicesRequestBodyDiscounts'Variants
- data PostInvoicesRequestBodyMetadata'Variants
- data PostInvoicesRequestBodyPaymentSettings' = PostInvoicesRequestBodyPaymentSettings' {}
- mkPostInvoicesRequestBodyPaymentSettings' :: PostInvoicesRequestBodyPaymentSettings'
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions' = PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions' {
- postInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact :: Maybe PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'Variants
- postInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card :: Maybe PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'Variants
- mkPostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions' :: PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 = PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 {}
- mkPostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 :: PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'
- = PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'Other Value
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'Typed Text
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'EnumDe
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'EnumEn
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'EnumFr
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'EnumNl
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'Variants
- = PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'EmptyString
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 = PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 {}
- mkPostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 :: PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'
- = PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'Other Value
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'Typed Text
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'EnumAny
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'EnumAutomatic
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'Variants
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1
- = PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1Other Value
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1Typed Text
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumAchCreditTransfer
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumAchDebit
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumAuBecsDebit
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumBacsDebit
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumBancontact
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumCard
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumFpx
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumGiropay
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumIdeal
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumSepaDebit
- | PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1EnumSofort
- data PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'Variants
- data PostInvoicesRequestBodyTransferData' = PostInvoicesRequestBodyTransferData' {}
- mkPostInvoicesRequestBodyTransferData' :: Text -> PostInvoicesRequestBodyTransferData'
- data PostInvoicesResponse
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => PostInvoicesRequestBody | The request body to send |
| -> ClientT m (Response PostInvoicesResponse) | Monadic computation which returns 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. The invoice remains a draft until you <a href="#finalize_invoice">finalize</a> the invoice, which allows you to <a href="#pay_invoice">pay</a> or <a href="#send_invoice">send</a> the invoice to your customers.</p>
data PostInvoicesRequestBody Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
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] # | |
mkPostInvoicesRequestBody Source #
Arguments
| :: Text | |
| -> PostInvoicesRequestBody |
Create a new PostInvoicesRequestBody with all required fields.
data PostInvoicesRequestBodyAccountTaxIds'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.account_tax_ids.anyOf in the specification.
The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
Constructors
| PostInvoicesRequestBodyAccountTaxIds'EmptyString | Represents the JSON value |
| PostInvoicesRequestBodyAccountTaxIds'ListTText [Text] |
data PostInvoicesRequestBodyAutomaticTax' Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax in the specification.
Settings for automatic tax lookup for this invoice.
Constructors
| PostInvoicesRequestBodyAutomaticTax' | |
Fields | |
Instances
mkPostInvoicesRequestBodyAutomaticTax' Source #
Create a new PostInvoicesRequestBodyAutomaticTax' with all required fields.
data PostInvoicesRequestBodyCollectionMethod' Source #
Defines the enum schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.collection_method in the specification.
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
| PostInvoicesRequestBodyCollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostInvoicesRequestBodyCollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostInvoicesRequestBodyCollectionMethod'EnumChargeAutomatically | Represents the JSON value |
| PostInvoicesRequestBodyCollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
data PostInvoicesRequestBodyCustomFields'OneOf1 Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.custom_fields.anyOf.items in the specification.
Constructors
| PostInvoicesRequestBodyCustomFields'OneOf1 | |
Fields
| |
Instances
mkPostInvoicesRequestBodyCustomFields'OneOf1 Source #
Arguments
| :: Text | |
| -> Text | |
| -> PostInvoicesRequestBodyCustomFields'OneOf1 |
Create a new PostInvoicesRequestBodyCustomFields'OneOf1 with all required fields.
data PostInvoicesRequestBodyCustomFields'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.custom_fields.anyOf in the specification.
A list of up to 4 custom fields to be displayed on the invoice.
Constructors
Instances
data PostInvoicesRequestBodyDiscounts'OneOf1 Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.anyOf.items in the specification.
Constructors
| PostInvoicesRequestBodyDiscounts'OneOf1 | |
Fields
| |
Instances
mkPostInvoicesRequestBodyDiscounts'OneOf1 :: PostInvoicesRequestBodyDiscounts'OneOf1 Source #
Create a new PostInvoicesRequestBodyDiscounts'OneOf1 with all required fields.
data PostInvoicesRequestBodyDiscounts'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.anyOf in the specification.
The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
Constructors
| PostInvoicesRequestBodyDiscounts'EmptyString | Represents the JSON value |
| PostInvoicesRequestBodyDiscounts'ListTPostInvoicesRequestBodyDiscounts'OneOf1 [PostInvoicesRequestBodyDiscounts'OneOf1] |
Instances
data PostInvoicesRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.
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'EmptyString | Represents the JSON value |
| PostInvoicesRequestBodyMetadata'Object Object |
Instances
data PostInvoicesRequestBodyPaymentSettings' Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings in the specification.
Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
Constructors
Instances
mkPostInvoicesRequestBodyPaymentSettings' :: PostInvoicesRequestBodyPaymentSettings' Source #
Create a new PostInvoicesRequestBodyPaymentSettings' with all required fields.
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions' Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options in the specification.
Constructors
Instances
mkPostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions' :: PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions' Source #
Create a new PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions' with all required fields.
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf in the specification.
Instances
mkPostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 :: PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 Source #
Create a new PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 with all required fields.
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage' Source #
Defines the enum schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf.properties.preferred_language in the specification.
Constructors
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'EnumDe | Represents the JSON value |
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'EnumEn | Represents the JSON value |
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'EnumFr | Represents the JSON value |
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1PreferredLanguage'EnumNl | Represents the JSON value |
Instances
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf in the specification.
Constructors
Instances
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf in the specification.
Instances
mkPostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 :: PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 Source #
Create a new PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 with all required fields.
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure' Source #
Defines the enum schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf.properties.request_three_d_secure in the specification.
Constructors
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'EnumAny | Represents the JSON value |
| PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1RequestThreeDSecure'EnumAutomatic | Represents the JSON value |
Instances
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodOptions'Card'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf in the specification.
Constructors
Instances
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'OneOf1 Source #
Defines the enum schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_types.anyOf.items in the specification.
Constructors
Instances
data PostInvoicesRequestBodyPaymentSettings'PaymentMethodTypes'Variants Source #
Defines the oneOf schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_types.anyOf in the specification.
Constructors
Instances
data PostInvoicesRequestBodyTransferData' Source #
Defines the object schema located at paths./v1/invoices.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data in the specification.
If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
Constructors
| PostInvoicesRequestBodyTransferData' | |
Fields
| |
Instances
mkPostInvoicesRequestBodyTransferData' Source #
Arguments
| :: Text | |
| -> PostInvoicesRequestBodyTransferData' |
Create a new PostInvoicesRequestBodyTransferData' with all required fields.
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 # | |