Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostInvoiceitemsInvoiceitem

Description

Contains the different functions to run the operation postInvoiceitemsInvoiceitem

Synopsis

postInvoiceitemsInvoiceitem :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoiceitemsInvoiceitemRequestBody -> m (Either HttpException (Response PostInvoiceitemsInvoiceitemResponse))
postInvoiceitemsInvoiceitemRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoiceitemsInvoiceitemRequestBody -> m (Either HttpException (Response ByteString))
postInvoiceitemsInvoiceitemM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoiceitemsInvoiceitemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoiceitemsInvoiceitemResponse))
postInvoiceitemsInvoiceitemRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoiceitemsInvoiceitemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostInvoiceitemsInvoiceitemRequestBody = PostInvoiceitemsInvoiceitemRequestBody {
}
data PostInvoiceitemsInvoiceitemRequestBodyMetadata' = PostInvoiceitemsInvoiceitemRequestBodyMetadata' {
}
data PostInvoiceitemsInvoiceitemRequestBodyPeriod' = PostInvoiceitemsInvoiceitemRequestBodyPeriod' {
- postInvoiceitemsInvoiceitemRequestBodyPeriod'End :: Integer
- postInvoiceitemsInvoiceitemRequestBodyPeriod'Start :: Integer
}
data PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1
data PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants
- = PostInvoiceitemsInvoiceitemRequestBodyTaxRates'PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1 PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1
- | PostInvoiceitemsInvoiceitemRequestBodyTaxRates'ListText ([] Text)
data PostInvoiceitemsInvoiceitemResponse

Documentation

postInvoiceitemsInvoiceitem Source #

Arguments

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

POST /v1/invoiceitems/{invoiceitem}

<p>Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.</p>

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

POST /v1/invoiceitems/{invoiceitem}

The same as postInvoiceitemsInvoiceitem but returns the raw ByteString

postInvoiceitemsInvoiceitemM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoiceitemsInvoiceitemRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoiceitemsInvoiceitemResponse)) Source #

POST /v1/invoiceitems/{invoiceitem}

Monadic version of postInvoiceitemsInvoiceitem (use with runWithConfiguration)

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

POST /v1/invoiceitems/{invoiceitem}

Monadic version of postInvoiceitemsInvoiceitemRaw (use with runWithConfiguration)

data PostInvoiceitemsInvoiceitemRequestBody Source #

Defines the data type for the schema postInvoiceitemsInvoiceitemRequestBody

Constructors

PostInvoiceitemsInvoiceitemRequestBody

Fields

postInvoiceitemsInvoiceitemRequestBodyAmount :: Maybe Integer
amount: The integer amount in **%s** of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
postInvoiceitemsInvoiceitemRequestBodyDescription :: Maybe Text
description: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
Constraints:
- Maximum length of 5000
postInvoiceitemsInvoiceitemRequestBodyDiscountable :: Maybe Bool
discountable: Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.
postInvoiceitemsInvoiceitemRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postInvoiceitemsInvoiceitemRequestBodyMetadata :: Maybe PostInvoiceitemsInvoiceitemRequestBodyMetadata'
metadata: 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`.
postInvoiceitemsInvoiceitemRequestBodyPeriod :: Maybe PostInvoiceitemsInvoiceitemRequestBodyPeriod'
period: The period associated with this invoice item.
postInvoiceitemsInvoiceitemRequestBodyQuantity :: Maybe Integer
quantity: Non-negative integer. The quantity of units for the invoice item.
postInvoiceitemsInvoiceitemRequestBodyTaxRates :: Maybe PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants
tax_rates: The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.
postInvoiceitemsInvoiceitemRequestBodyUnitAmount :: Maybe Integer
unit_amount: The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
postInvoiceitemsInvoiceitemRequestBodyUnitAmountDecimal :: Maybe Text
unit_amount_decimal: Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.

Instances

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

data PostInvoiceitemsInvoiceitemRequestBodyMetadata' Source #

Defines the data type for the schema postInvoiceitemsInvoiceitemRequestBodyMetadata'

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

PostInvoiceitemsInvoiceitemRequestBodyMetadata'

Instances

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

data PostInvoiceitemsInvoiceitemRequestBodyPeriod' Source #

Defines the data type for the schema postInvoiceitemsInvoiceitemRequestBodyPeriod'

The period associated with this invoice item.

Constructors

PostInvoiceitemsInvoiceitemRequestBodyPeriod'
Fields postInvoiceitemsInvoiceitemRequestBodyPeriod'End :: Integer end postInvoiceitemsInvoiceitemRequestBodyPeriod'Start :: Integer start

Instances

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

data PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1 Source #

Defines the enum schema postInvoiceitemsInvoiceitemRequestBodyTax_rates'OneOf1

Constructors

PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1EnumOther Value
PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1EnumTyped Text
PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1EnumString_

Instances

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

data PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants Source #

Define the one-of schema postInvoiceitemsInvoiceitemRequestBodyTax_rates'

The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.

Constructors

PostInvoiceitemsInvoiceitemRequestBodyTaxRates'PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1 PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1
PostInvoiceitemsInvoiceitemRequestBodyTaxRates'ListText ([] Text)

Instances

Eq PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitemsInvoiceitem Methods (==) :: PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> Bool # (/=) :: PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> Bool #
Show PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitemsInvoiceitem Methods showsPrec :: Int -> PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> ShowS # show :: PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> String # showList :: [PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants] -> ShowS #
Generic PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitemsInvoiceitem Associated Types type Rep PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants :: Type -> Type # Methods from :: PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> Rep PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants x # to :: Rep PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants x -> PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants #
ToJSON PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitemsInvoiceitem Methods toJSON :: PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> Value # toEncoding :: PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants -> Encoding # toJSONList :: [PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants] -> Value # toEncodingList :: [PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants] -> Encoding #
FromJSON PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitemsInvoiceitem Methods parseJSON :: Value -> Parser PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants # parseJSONList :: Value -> Parser [PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants] #
type Rep PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitemsInvoiceitem type Rep PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants = D1 (MetaData "PostInvoiceitemsInvoiceitemRequestBodyTaxRates'Variants" "StripeAPI.Operations.PostInvoiceitemsInvoiceitem" "stripeapi-0.1.0.2-D0ebvtj6l9B4TLqRwmHKaP" False) (C1 (MetaCons "PostInvoiceitemsInvoiceitemRequestBodyTaxRates'PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostInvoiceitemsInvoiceitemRequestBodyTaxRates'OneOf1)) :+: C1 (MetaCons "PostInvoiceitemsInvoiceitemRequestBodyTaxRates'ListText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

data PostInvoiceitemsInvoiceitemResponse Source #

Represents a response of the operation postInvoiceitemsInvoiceitem.

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

Constructors

PostInvoiceitemsInvoiceitemResponseError String	Means either no matching case available or a parse error
PostInvoiceitemsInvoiceitemResponse200 Invoiceitem	Successful response.
PostInvoiceitemsInvoiceitemResponseDefault Error	Error response.

Instances

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