stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostInvoicesInvoice

Description

Contains the different functions to run the operation postInvoicesInvoice

Synopsis

Documentation

postInvoicesInvoice Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

invoice | Constraints: Maximum length of 5000

-> PostInvoicesInvoiceRequestBody

The request body to send

-> m (Either HttpException (Response PostInvoicesInvoiceResponse))

Monad containing the result of the operation

POST /v1/invoices/{invoice}

<p>Draft invoices are fully editable. Once an invoice is <a href="/docs/billing/invoices/workflow#finalized">finalized</a>, monetary values, as well as <code>collection_method</code>, become uneditable.</p>

<p>If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or <a href="/docs/billing/invoices/reconciliation">automatically reconciling</a> invoices, pass <code>auto_advance=false</code>.</p>

postInvoicesInvoiceRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostInvoicesInvoiceRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/invoices/{invoice}

The same as postInvoicesInvoice but returns the raw ByteString

data PostInvoicesInvoiceRequestBody Source #

Defines the data type for the schema postInvoicesInvoiceRequestBody

Constructors

PostInvoicesInvoiceRequestBody 

Fields

data PostInvoicesInvoiceRequestBodyCollectionMethod' Source #

Defines the enum schema postInvoicesInvoiceRequestBodyCollection_method'

Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.

data PostInvoicesInvoiceRequestBodyCustomFields'OneOf1 Source #

Defines the enum schema postInvoicesInvoiceRequestBodyCustom_fields'OneOf1

Instances
Eq PostInvoicesInvoiceRequestBodyCustomFields'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Show PostInvoicesInvoiceRequestBodyCustomFields'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

ToJSON PostInvoicesInvoiceRequestBodyCustomFields'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

FromJSON PostInvoicesInvoiceRequestBodyCustomFields'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

data PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 Source #

Defines the data type for the schema postInvoicesInvoiceRequestBodyCustom_fields'OneOf2

Instances
Eq PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Show PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

ToJSON PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

FromJSON PostInvoicesInvoiceRequestBodyCustomFields'OneOf2 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

data PostInvoicesInvoiceRequestBodyCustomFields'Variants Source #

Define the one-of schema postInvoicesInvoiceRequestBodyCustom_fields'

A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.

Instances
Eq PostInvoicesInvoiceRequestBodyCustomFields'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Show PostInvoicesInvoiceRequestBodyCustomFields'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Generic PostInvoicesInvoiceRequestBodyCustomFields'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

ToJSON PostInvoicesInvoiceRequestBodyCustomFields'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

FromJSON PostInvoicesInvoiceRequestBodyCustomFields'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

type Rep PostInvoicesInvoiceRequestBodyCustomFields'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

type Rep PostInvoicesInvoiceRequestBodyCustomFields'Variants = D1 (MetaData "PostInvoicesInvoiceRequestBodyCustomFields'Variants" "StripeAPI.Operations.PostInvoicesInvoice" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostInvoicesInvoiceRequestBodyCustomFields'PostInvoicesInvoiceRequestBodyCustomFields'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostInvoicesInvoiceRequestBodyCustomFields'OneOf1)) :+: C1 (MetaCons "PostInvoicesInvoiceRequestBodyCustomFields'ListPostInvoicesInvoiceRequestBodyCustomFields'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PostInvoicesInvoiceRequestBodyCustomFields'OneOf2])))

data PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1 Source #

Defines the enum schema postInvoicesInvoiceRequestBodyDefault_tax_rates'OneOf1

Instances
Eq PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Show PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

ToJSON PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

FromJSON PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

data PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants Source #

Define the one-of schema postInvoicesInvoiceRequestBodyDefault_tax_rates'

The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates.

Instances
Eq PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Show PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Generic PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

ToJSON PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

FromJSON PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

type Rep PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

type Rep PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants = D1 (MetaData "PostInvoicesInvoiceRequestBodyDefaultTaxRates'Variants" "StripeAPI.Operations.PostInvoicesInvoice" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostInvoicesInvoiceRequestBodyDefaultTaxRates'PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostInvoicesInvoiceRequestBodyDefaultTaxRates'OneOf1)) :+: C1 (MetaCons "PostInvoicesInvoiceRequestBodyDefaultTaxRates'ListString" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))

data PostInvoicesInvoiceRequestBodyMetadata' Source #

Defines the data type for the schema postInvoicesInvoiceRequestBodyMetadata'

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 PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1 Source #

Defines the enum schema postInvoicesInvoiceRequestBodyTax_percent'OneOf1

data PostInvoicesInvoiceRequestBodyTaxPercent'Variants Source #

Define the one-of schema postInvoicesInvoiceRequestBodyTax_percent'

The percent tax rate applied to the invoice, represented as a non-negative decimal number (with at most four decimal places) between 0 and 100. To unset a previously-set value, pass an empty string. This field can be updated only on `draft` invoices. This field has been deprecated and will be removed in a future API version, for further information view the migration docs for `tax_rates`.

Instances
Eq PostInvoicesInvoiceRequestBodyTaxPercent'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Show PostInvoicesInvoiceRequestBodyTaxPercent'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

Generic PostInvoicesInvoiceRequestBodyTaxPercent'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

ToJSON PostInvoicesInvoiceRequestBodyTaxPercent'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

FromJSON PostInvoicesInvoiceRequestBodyTaxPercent'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

type Rep PostInvoicesInvoiceRequestBodyTaxPercent'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostInvoicesInvoice

type Rep PostInvoicesInvoiceRequestBodyTaxPercent'Variants = D1 (MetaData "PostInvoicesInvoiceRequestBodyTaxPercent'Variants" "StripeAPI.Operations.PostInvoicesInvoice" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostInvoicesInvoiceRequestBodyTaxPercent'PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostInvoicesInvoiceRequestBodyTaxPercent'OneOf1)) :+: C1 (MetaCons "PostInvoicesInvoiceRequestBodyTaxPercent'Double" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)))

data PostInvoicesInvoiceResponse Source #

Represents a response of the operation postInvoicesInvoice.

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

Constructors

PostInvoicesInvoiceResponseError String

Means either no matching case available or a parse error

PostInvoicesInvoiceResponse200 Invoice

Successful response.

PostInvoicesInvoiceResponseDefault Error

Error response.