Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostInvoiceitems

Description

Contains the different functions to run the operation postInvoiceitems

Synopsis

postInvoiceitems :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostInvoiceitemsRequestBody -> m (Either HttpException (Response PostInvoiceitemsResponse))
postInvoiceitemsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostInvoiceitemsRequestBody -> m (Either HttpException (Response ByteString))
postInvoiceitemsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostInvoiceitemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoiceitemsResponse))
postInvoiceitemsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostInvoiceitemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostInvoiceitemsRequestBody = PostInvoiceitemsRequestBody {
}
data PostInvoiceitemsRequestBodyMetadata' = PostInvoiceitemsRequestBodyMetadata' {
}
data PostInvoiceitemsRequestBodyPeriod' = PostInvoiceitemsRequestBodyPeriod' {
- postInvoiceitemsRequestBodyPeriod'End :: Integer
- postInvoiceitemsRequestBodyPeriod'Start :: Integer
}
data PostInvoiceitemsResponse

Documentation

postInvoiceitems Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> PostInvoiceitemsRequestBody	The request body to send
-> m (Either HttpException (Response PostInvoiceitemsResponse))	Monad containing the result of the operation

POST /v1/invoiceitems

<p>Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.</p>

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

POST /v1/invoiceitems

The same as postInvoiceitems but returns the raw ByteString

postInvoiceitemsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostInvoiceitemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoiceitemsResponse)) Source #

POST /v1/invoiceitems

Monadic version of postInvoiceitems (use with runWithConfiguration)

postInvoiceitemsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostInvoiceitemsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/invoiceitems

Monadic version of postInvoiceitemsRaw (use with runWithConfiguration)

data PostInvoiceitemsRequestBody Source #

Defines the data type for the schema postInvoiceitemsRequestBody

Constructors

PostInvoiceitemsRequestBody

Fields

postInvoiceitemsRequestBodyAmount :: Maybe Integer
amount: The integer amount in **%s** of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
postInvoiceitemsRequestBodyCurrency :: Maybe Text
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
postInvoiceitemsRequestBodyCustomer :: Text
customer: The ID of the customer who will be billed when this invoice item is billed.
Constraints:
- Maximum length of 5000
postInvoiceitemsRequestBodyDescription :: 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
postInvoiceitemsRequestBodyDiscountable :: 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.
postInvoiceitemsRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postInvoiceitemsRequestBodyInvoice :: Maybe Text
invoice: The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices.
Constraints:
- Maximum length of 5000
postInvoiceitemsRequestBodyMetadata :: Maybe PostInvoiceitemsRequestBodyMetadata'
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`.
postInvoiceitemsRequestBodyPeriod :: Maybe PostInvoiceitemsRequestBodyPeriod'
period: The period associated with this invoice item.
postInvoiceitemsRequestBodyQuantity :: Maybe Integer
quantity: Non-negative integer. The quantity of units for the invoice item.
postInvoiceitemsRequestBodySubscription :: Maybe Text
subscription: The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
Constraints:
- Maximum length of 5000
postInvoiceitemsRequestBodyTaxRates :: Maybe ([] Text)
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.
postInvoiceitemsRequestBodyUnitAmount :: 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. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.
postInvoiceitemsRequestBodyUnitAmountDecimal :: 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 PostInvoiceitemsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitems Methods (==) :: PostInvoiceitemsRequestBody -> PostInvoiceitemsRequestBody -> Bool # (/=) :: PostInvoiceitemsRequestBody -> PostInvoiceitemsRequestBody -> Bool #
Show PostInvoiceitemsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitems Methods showsPrec :: Int -> PostInvoiceitemsRequestBody -> ShowS # show :: PostInvoiceitemsRequestBody -> String # showList :: [PostInvoiceitemsRequestBody] -> ShowS #
ToJSON PostInvoiceitemsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitems Methods toJSON :: PostInvoiceitemsRequestBody -> Value # toEncoding :: PostInvoiceitemsRequestBody -> Encoding # toJSONList :: [PostInvoiceitemsRequestBody] -> Value # toEncodingList :: [PostInvoiceitemsRequestBody] -> Encoding #
FromJSON PostInvoiceitemsRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostInvoiceitems Methods parseJSON :: Value -> Parser PostInvoiceitemsRequestBody # parseJSONList :: Value -> Parser [PostInvoiceitemsRequestBody] #

data PostInvoiceitemsRequestBodyMetadata' Source #

Defines the data type for the schema postInvoiceitemsRequestBodyMetadata'

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

PostInvoiceitemsRequestBodyMetadata'

Instances

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

data PostInvoiceitemsRequestBodyPeriod' Source #

Defines the data type for the schema postInvoiceitemsRequestBodyPeriod'

The period associated with this invoice item.

Constructors

PostInvoiceitemsRequestBodyPeriod'
Fields postInvoiceitemsRequestBodyPeriod'End :: Integer end postInvoiceitemsRequestBodyPeriod'Start :: Integer start

Instances

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

data PostInvoiceitemsResponse Source #

Represents a response of the operation postInvoiceitems.

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

Constructors

PostInvoiceitemsResponseError String	Means either no matching case available or a parse error
PostInvoiceitemsResponse200 Invoiceitem	Successful response.
PostInvoiceitemsResponseDefault Error	Error response.

Instances

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