StripeAPI.Operations.PostInvoices

Contains the different functions to run the operation postInvoices

Documentation

postInvoices

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))

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))

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))

POST /v1/invoices

Monadic version of postInvoicesRaw (use with runWithConfiguration)

data PostInvoicesRequestBody

Defines the data type for the schema postInvoicesRequestBody

Constructors

PostInvoicesRequestBody

Fields

• postInvoicesRequestBodyApplicationFeeAmount :: Maybe Integer

  application_fee_amount: A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

• postInvoicesRequestBodyAutoAdvance :: Maybe Bool

  auto_advance: Controls whether Stripe will perform automatic collection of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.

• postInvoicesRequestBodyCollectionMethod :: Maybe PostInvoicesRequestBodyCollectionMethod'

  collection_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`.

  Constraints:

  • Maximum length of 5000
• postInvoicesRequestBodyCustomFields :: Maybe PostInvoicesRequestBodyCustomFields'Variants

  custom_fields: A list of up to 4 custom fields to be displayed on the invoice.

• postInvoicesRequestBodyCustomer :: String

  customer: The ID of the customer who will be billed.

  Constraints:

  • Maximum length of 5000
• postInvoicesRequestBodyDaysUntilDue :: Maybe Integer

  days_until_due: The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.

• postInvoicesRequestBodyDefaultPaymentMethod :: Maybe String

  default_payment_method: ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.

  Constraints:

  • Maximum length of 5000
• postInvoicesRequestBodyDefaultSource :: Maybe String

  default_source: ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.

  Constraints:

  • Maximum length of 5000
• postInvoicesRequestBodyDefaultTaxRates :: Maybe ([] String)

  default_tax_rates: The tax rates that will apply to any line item that does not have `tax_rates` set.

• postInvoicesRequestBodyDescription :: Maybe String

  description: An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.

  Constraints:

  • Maximum length of 1500
• postInvoicesRequestBodyDueDate :: Maybe Integer

  due_date: The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.

• postInvoicesRequestBodyExpand :: Maybe ([] String)

  expand: Specifies which fields in the response should be expanded.

• postInvoicesRequestBodyFooter :: Maybe String

  footer: Footer to be displayed on the invoice.

  Constraints:

  • Maximum length of 5000
• postInvoicesRequestBodyMetadata :: Maybe PostInvoicesRequestBodyMetadata'

  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`.

• postInvoicesRequestBodyStatementDescriptor :: Maybe String

  statement_descriptor: Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.

  Constraints:

  • Maximum length of 22
• postInvoicesRequestBodySubscription :: Maybe String

  subscription: The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected.

  Constraints:

  • Maximum length of 5000
• postInvoicesRequestBodyTaxPercent :: Maybe Double

  tax_percent: The percent tax rate applied to the invoice, represented as a decimal number. 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 PostInvoicesRequestBody

Defined in StripeAPI.Operations.PostInvoices

Methods

(==) :: PostInvoicesRequestBody -> PostInvoicesRequestBody -> Bool

(/=) :: PostInvoicesRequestBody -> PostInvoicesRequestBody -> Bool

Show PostInvoicesRequestBody

Defined in StripeAPI.Operations.PostInvoices

Methods

showsPrec :: Int -> PostInvoicesRequestBody -> ShowS

show :: PostInvoicesRequestBody -> String

showList :: [PostInvoicesRequestBody] -> ShowS

ToJSON PostInvoicesRequestBody

Defined in StripeAPI.Operations.PostInvoices

Methods

toJSON :: PostInvoicesRequestBody -> Value

toEncoding :: PostInvoicesRequestBody -> Encoding

toJSONList :: [PostInvoicesRequestBody] -> Value

toEncodingList :: [PostInvoicesRequestBody] -> Encoding

FromJSON PostInvoicesRequestBody

Defined in StripeAPI.Operations.PostInvoices

Methods

parseJSON :: Value -> Parser PostInvoicesRequestBody

parseJSONList :: Value -> Parser [PostInvoicesRequestBody]

data PostInvoicesRequestBodyCollectionMethod'

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

PostInvoicesRequestBodyCollectionMethod'EnumOther Value

PostInvoicesRequestBodyCollectionMethod'EnumTyped String

PostInvoicesRequestBodyCollectionMethod'EnumStringChargeAutomatically

PostInvoicesRequestBodyCollectionMethod'EnumStringSendInvoice

Instances

Eq PostInvoicesRequestBodyCollectionMethod'

Defined in StripeAPI.Operations.PostInvoices

Methods

(==) :: PostInvoicesRequestBodyCollectionMethod' -> PostInvoicesRequestBodyCollectionMethod' -> Bool

(/=) :: PostInvoicesRequestBodyCollectionMethod' -> PostInvoicesRequestBodyCollectionMethod' -> Bool

Show PostInvoicesRequestBodyCollectionMethod'

Defined in StripeAPI.Operations.PostInvoices

Methods

showsPrec :: Int -> PostInvoicesRequestBodyCollectionMethod' -> ShowS

show :: PostInvoicesRequestBodyCollectionMethod' -> String

showList :: [PostInvoicesRequestBodyCollectionMethod'] -> ShowS

ToJSON PostInvoicesRequestBodyCollectionMethod'

Defined in StripeAPI.Operations.PostInvoices

Methods

toJSON :: PostInvoicesRequestBodyCollectionMethod' -> Value

toEncoding :: PostInvoicesRequestBodyCollectionMethod' -> Encoding

toJSONList :: [PostInvoicesRequestBodyCollectionMethod'] -> Value

toEncodingList :: [PostInvoicesRequestBodyCollectionMethod'] -> Encoding

FromJSON PostInvoicesRequestBodyCollectionMethod'

Defined in StripeAPI.Operations.PostInvoices

Methods

parseJSON :: Value -> Parser PostInvoicesRequestBodyCollectionMethod'

parseJSONList :: Value -> Parser [PostInvoicesRequestBodyCollectionMethod']

data PostInvoicesRequestBodyCustomFields'OneOf1

Defines the enum schema postInvoicesRequestBodyCustom_fields'OneOf1

Constructors

PostInvoicesRequestBodyCustomFields'OneOf1EnumOther Value

PostInvoicesRequestBodyCustomFields'OneOf1EnumTyped String

PostInvoicesRequestBodyCustomFields'OneOf1EnumString_

Instances

Eq PostInvoicesRequestBodyCustomFields'OneOf1

Defined in StripeAPI.Operations.PostInvoices

Methods

(==) :: PostInvoicesRequestBodyCustomFields'OneOf1 -> PostInvoicesRequestBodyCustomFields'OneOf1 -> Bool

(/=) :: PostInvoicesRequestBodyCustomFields'OneOf1 -> PostInvoicesRequestBodyCustomFields'OneOf1 -> Bool

Show PostInvoicesRequestBodyCustomFields'OneOf1

Defined in StripeAPI.Operations.PostInvoices

Methods

showsPrec :: Int -> PostInvoicesRequestBodyCustomFields'OneOf1 -> ShowS

show :: PostInvoicesRequestBodyCustomFields'OneOf1 -> String

showList :: [PostInvoicesRequestBodyCustomFields'OneOf1] -> ShowS

ToJSON PostInvoicesRequestBodyCustomFields'OneOf1

Defined in StripeAPI.Operations.PostInvoices

Methods

toJSON :: PostInvoicesRequestBodyCustomFields'OneOf1 -> Value

toEncoding :: PostInvoicesRequestBodyCustomFields'OneOf1 -> Encoding

toJSONList :: [PostInvoicesRequestBodyCustomFields'OneOf1] -> Value

toEncodingList :: [PostInvoicesRequestBodyCustomFields'OneOf1] -> Encoding

FromJSON PostInvoicesRequestBodyCustomFields'OneOf1

Defined in StripeAPI.Operations.PostInvoices

Methods

parseJSON :: Value -> Parser PostInvoicesRequestBodyCustomFields'OneOf1

parseJSONList :: Value -> Parser [PostInvoicesRequestBodyCustomFields'OneOf1]

data PostInvoicesRequestBodyCustomFields'OneOf2

Defines the data type for the schema postInvoicesRequestBodyCustom_fields'OneOf2

Constructors

PostInvoicesRequestBodyCustomFields'OneOf2

Fields

• postInvoicesRequestBodyCustomFields'OneOf2Name :: String

  name

  Constraints:

  • Maximum length of 30
• postInvoicesRequestBodyCustomFields'OneOf2Value :: String

  value

  Constraints:

  • Maximum length of 30

Instances

Eq PostInvoicesRequestBodyCustomFields'OneOf2

Defined in StripeAPI.Operations.PostInvoices

Methods

(==) :: PostInvoicesRequestBodyCustomFields'OneOf2 -> PostInvoicesRequestBodyCustomFields'OneOf2 -> Bool

(/=) :: PostInvoicesRequestBodyCustomFields'OneOf2 -> PostInvoicesRequestBodyCustomFields'OneOf2 -> Bool

Show PostInvoicesRequestBodyCustomFields'OneOf2

Defined in StripeAPI.Operations.PostInvoices

Methods

showsPrec :: Int -> PostInvoicesRequestBodyCustomFields'OneOf2 -> ShowS

show :: PostInvoicesRequestBodyCustomFields'OneOf2 -> String

showList :: [PostInvoicesRequestBodyCustomFields'OneOf2] -> ShowS

ToJSON PostInvoicesRequestBodyCustomFields'OneOf2

Defined in StripeAPI.Operations.PostInvoices

Methods

toJSON :: PostInvoicesRequestBodyCustomFields'OneOf2 -> Value

toEncoding :: PostInvoicesRequestBodyCustomFields'OneOf2 -> Encoding

toJSONList :: [PostInvoicesRequestBodyCustomFields'OneOf2] -> Value

toEncodingList :: [PostInvoicesRequestBodyCustomFields'OneOf2] -> Encoding

FromJSON PostInvoicesRequestBodyCustomFields'OneOf2

Defined in StripeAPI.Operations.PostInvoices

Methods

parseJSON :: Value -> Parser PostInvoicesRequestBodyCustomFields'OneOf2

parseJSONList :: Value -> Parser [PostInvoicesRequestBodyCustomFields'OneOf2]

data PostInvoicesRequestBodyCustomFields'Variants

Define the one-of schema postInvoicesRequestBodyCustom_fields'

A list of up to 4 custom fields to be displayed on the invoice.

Constructors

PostInvoicesRequestBodyCustomFields'PostInvoicesRequestBodyCustomFields'OneOf1 PostInvoicesRequestBodyCustomFields'OneOf1

PostInvoicesRequestBodyCustomFields'ListPostInvoicesRequestBodyCustomFields'OneOf2 ([] PostInvoicesRequestBodyCustomFields'OneOf2)

Instances

Eq PostInvoicesRequestBodyCustomFields'Variants

Defined in StripeAPI.Operations.PostInvoices

Methods

(==) :: PostInvoicesRequestBodyCustomFields'Variants -> PostInvoicesRequestBodyCustomFields'Variants -> Bool

(/=) :: PostInvoicesRequestBodyCustomFields'Variants -> PostInvoicesRequestBodyCustomFields'Variants -> Bool

Show PostInvoicesRequestBodyCustomFields'Variants

Defined in StripeAPI.Operations.PostInvoices

Methods

showsPrec :: Int -> PostInvoicesRequestBodyCustomFields'Variants -> ShowS

show :: PostInvoicesRequestBodyCustomFields'Variants -> String

showList :: [PostInvoicesRequestBodyCustomFields'Variants] -> ShowS

Generic PostInvoicesRequestBodyCustomFields'Variants

Defined in StripeAPI.Operations.PostInvoices

Associated Types

type Rep PostInvoicesRequestBodyCustomFields'Variants :: Type -> Type

Methods

from :: PostInvoicesRequestBodyCustomFields'Variants -> Rep PostInvoicesRequestBodyCustomFields'Variants x

to :: Rep PostInvoicesRequestBodyCustomFields'Variants x -> PostInvoicesRequestBodyCustomFields'Variants

ToJSON PostInvoicesRequestBodyCustomFields'Variants

Defined in StripeAPI.Operations.PostInvoices

Methods

toJSON :: PostInvoicesRequestBodyCustomFields'Variants -> Value

toEncoding :: PostInvoicesRequestBodyCustomFields'Variants -> Encoding

toJSONList :: [PostInvoicesRequestBodyCustomFields'Variants] -> Value

toEncodingList :: [PostInvoicesRequestBodyCustomFields'Variants] -> Encoding

FromJSON PostInvoicesRequestBodyCustomFields'Variants

Defined in StripeAPI.Operations.PostInvoices

Methods

parseJSON :: Value -> Parser PostInvoicesRequestBodyCustomFields'Variants

parseJSONList :: Value -> Parser [PostInvoicesRequestBodyCustomFields'Variants]

type Rep PostInvoicesRequestBodyCustomFields'Variants

Defined in StripeAPI.Operations.PostInvoices

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

data PostInvoicesRequestBodyMetadata'

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

Eq PostInvoicesRequestBodyMetadata'

Defined in StripeAPI.Operations.PostInvoices

Methods

(==) :: PostInvoicesRequestBodyMetadata' -> PostInvoicesRequestBodyMetadata' -> Bool

(/=) :: PostInvoicesRequestBodyMetadata' -> PostInvoicesRequestBodyMetadata' -> Bool

Show PostInvoicesRequestBodyMetadata'

Defined in StripeAPI.Operations.PostInvoices

Methods

showsPrec :: Int -> PostInvoicesRequestBodyMetadata' -> ShowS

show :: PostInvoicesRequestBodyMetadata' -> String

showList :: [PostInvoicesRequestBodyMetadata'] -> ShowS

ToJSON PostInvoicesRequestBodyMetadata'

Defined in StripeAPI.Operations.PostInvoices

Methods

toJSON :: PostInvoicesRequestBodyMetadata' -> Value

toEncoding :: PostInvoicesRequestBodyMetadata' -> Encoding

toJSONList :: [PostInvoicesRequestBodyMetadata'] -> Value

toEncodingList :: [PostInvoicesRequestBodyMetadata'] -> Encoding

FromJSON PostInvoicesRequestBodyMetadata'

Defined in StripeAPI.Operations.PostInvoices

Methods

parseJSON :: Value -> Parser PostInvoicesRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostInvoicesRequestBodyMetadata']

data PostInvoicesResponse

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

Defined in StripeAPI.Operations.PostInvoices

Methods

(==) :: PostInvoicesResponse -> PostInvoicesResponse -> Bool

(/=) :: PostInvoicesResponse -> PostInvoicesResponse -> Bool

Show PostInvoicesResponse

Defined in StripeAPI.Operations.PostInvoices

Methods

showsPrec :: Int -> PostInvoicesResponse -> ShowS

show :: PostInvoicesResponse -> String

showList :: [PostInvoicesResponse] -> ShowS