Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostInvoiceitems

Contains the different functions to run the operation postInvoiceitems

8 types
5 values

Packagestripeapi-3.0.0.0
Exports13
LanguageHaskell2010
LicenceMIT
SourcePostInvoiceitems.hs

valuepostInvoiceitems

:: MonadHTTP m
=> PostInvoiceitemsRequestBody
The request body to send
-> ClientT m (Response PostInvoiceitemsResponse)
Monadic computation which returns the result of the operation

POST /v1/invoiceitems

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

datadata PostInvoiceitemsRequestBody

Defines the object schema located at paths./v1/invoiceitems.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostInvoiceitemsRequestBody
- postInvoiceitemsRequestBodyAmount :: Maybe Int
  amount: The integer amount in cents (or local equivalent) 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.
- postInvoiceitemsRequestBodyDiscounts :: Maybe PostInvoiceitemsRequestBodyDiscounts'Variants
  discounts: The coupons to redeem into discounts for the invoice item or invoice line item.
- 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 and there is a maximum of 250 items per invoice.
  Constraints:
  - Maximum length of 5000
- postInvoiceitemsRequestBodyMetadata :: Maybe PostInvoiceitemsRequestBodyMetadata'Variants
  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. When set to different values, the period will be rendered on the invoice.
- postInvoiceitemsRequestBodyPrice :: Maybe Text
  price: The ID of the price object.
  Constraints:
  - Maximum length of 5000
- postInvoiceitemsRequestBodyPriceData :: Maybe PostInvoiceitemsRequestBodyPriceData'
  price_data: Data used to generate a new Price object inline.
- postInvoiceitemsRequestBodyQuantity :: Maybe Int
  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 Int
  unit_amount: The integer unit amount in cents (or local equivalent) 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 in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostInvoiceitemsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
Show PostInvoiceitemsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
FromJSON PostInvoiceitemsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
ToJSON PostInvoiceitemsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems

valuemkPostInvoiceitemsRequestBody

:: Text
postInvoiceitemsRequestBodyCustomer
-> PostInvoiceitemsRequestBody

Create a new PostInvoiceitemsRequestBody with all required fields.

datadata PostInvoiceitemsRequestBodyDiscounts'OneOf1

Defines the object schema located at paths./v1/invoiceitems.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.anyOf.items in the specification.

Constructors

PostInvoiceitemsRequestBodyDiscounts'OneOf1
- postInvoiceitemsRequestBodyDiscounts'OneOf1Coupon :: Maybe Text
  coupon
  Constraints:
  - Maximum length of 5000
- postInvoiceitemsRequestBodyDiscounts'OneOf1Discount :: Maybe Text
  discount
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostInvoiceitemsRequestBodyDiscounts'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
Show PostInvoiceitemsRequestBodyDiscounts'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
FromJSON PostInvoiceitemsRequestBodyDiscounts'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
ToJSON PostInvoiceitemsRequestBodyDiscounts'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems

valuemkPostInvoiceitemsRequestBodyDiscounts'OneOf1 :: PostInvoiceitemsRequestBodyDiscounts'OneOf1

Create a new PostInvoiceitemsRequestBodyDiscounts'OneOf1 with all required fields.

datadata PostInvoiceitemsRequestBodyDiscounts'Variants

Defines the oneOf schema located at paths./v1/invoiceitems.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.anyOf in the specification.

The coupons to redeem into discounts for the invoice item or invoice line item.

Constructors

PostInvoiceitemsRequestBodyDiscounts'EmptyString
Represents the JSON value ""
PostInvoiceitemsRequestBodyDiscounts'ListTPostInvoiceitemsRequestBodyDiscounts'OneOf1 [PostInvoiceitemsRequestBodyDiscounts'OneOf1]

Instances4Eq, Show, FromJSON, ToJSON

Eq PostInvoiceitemsRequestBodyDiscounts'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
Show PostInvoiceitemsRequestBodyDiscounts'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
FromJSON PostInvoiceitemsRequestBodyDiscounts'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
ToJSON PostInvoiceitemsRequestBodyDiscounts'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems

datadata PostInvoiceitemsRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/invoiceitems.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

PostInvoiceitemsRequestBodyMetadata'EmptyString
Represents the JSON value ""
PostInvoiceitemsRequestBodyMetadata'Object Object

Instances4Eq, Show, FromJSON, ToJSON

Eq PostInvoiceitemsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
Show PostInvoiceitemsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
FromJSON PostInvoiceitemsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
ToJSON PostInvoiceitemsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems

datadata PostInvoiceitemsRequestBodyPeriod'

Defines the object schema located at paths./v1/invoiceitems.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.period in the specification.

The period associated with this invoice item. When set to different values, the period will be rendered on the invoice.

Constructors

PostInvoiceitemsRequestBodyPeriod'
- postInvoiceitemsRequestBodyPeriod'End :: Int
  end
- postInvoiceitemsRequestBodyPeriod'Start :: Int
  start

Instances4Eq, Show, FromJSON, ToJSON

Eq PostInvoiceitemsRequestBodyPeriod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
Show PostInvoiceitemsRequestBodyPeriod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
FromJSON PostInvoiceitemsRequestBodyPeriod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
ToJSON PostInvoiceitemsRequestBodyPeriod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems

valuemkPostInvoiceitemsRequestBodyPeriod'

:: Int
postInvoiceitemsRequestBodyPeriod'End
-> Int
postInvoiceitemsRequestBodyPeriod'Start
-> PostInvoiceitemsRequestBodyPeriod'

Create a new PostInvoiceitemsRequestBodyPeriod' with all required fields.

datadata PostInvoiceitemsRequestBodyPriceData'

Defines the object schema located at paths./v1/invoiceitems.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.price_data in the specification.

Data used to generate a new Price object inline.

Constructors

PostInvoiceitemsRequestBodyPriceData'
- postInvoiceitemsRequestBodyPriceData'Currency :: Text
  currency
- postInvoiceitemsRequestBodyPriceData'Product :: Text
  product
  Constraints:
  - Maximum length of 5000
- postInvoiceitemsRequestBodyPriceData'TaxBehavior :: Maybe PostInvoiceitemsRequestBodyPriceData'TaxBehavior'
  tax_behavior
- postInvoiceitemsRequestBodyPriceData'UnitAmount :: Maybe Int
  unit_amount
- postInvoiceitemsRequestBodyPriceData'UnitAmountDecimal :: Maybe Text
  unit_amount_decimal

Instances4Eq, Show, FromJSON, ToJSON

Eq PostInvoiceitemsRequestBodyPriceData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
Show PostInvoiceitemsRequestBodyPriceData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
FromJSON PostInvoiceitemsRequestBodyPriceData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
ToJSON PostInvoiceitemsRequestBodyPriceData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems

valuemkPostInvoiceitemsRequestBodyPriceData'

:: Text
postInvoiceitemsRequestBodyPriceData'Currency
-> Text
postInvoiceitemsRequestBodyPriceData'Product
-> PostInvoiceitemsRequestBodyPriceData'

Create a new PostInvoiceitemsRequestBodyPriceData' with all required fields.

datadata PostInvoiceitemsRequestBodyPriceData'TaxBehavior'

Defines the enum schema located at paths./v1/invoiceitems.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.price_data.properties.tax_behavior in the specification.

Constructors

PostInvoiceitemsRequestBodyPriceData'TaxBehavior'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostInvoiceitemsRequestBodyPriceData'TaxBehavior'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PostInvoiceitemsRequestBodyPriceData'TaxBehavior'EnumExclusive
Represents the JSON value "exclusive"
PostInvoiceitemsRequestBodyPriceData'TaxBehavior'EnumInclusive
Represents the JSON value "inclusive"
PostInvoiceitemsRequestBodyPriceData'TaxBehavior'EnumUnspecified
Represents the JSON value "unspecified"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostInvoiceitemsRequestBodyPriceData'TaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
Show PostInvoiceitemsRequestBodyPriceData'TaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
FromJSON PostInvoiceitemsRequestBodyPriceData'TaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
ToJSON PostInvoiceitemsRequestBodyPriceData'TaxBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems

datadata PostInvoiceitemsResponse

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.

Instances2Eq, Show

Eq PostInvoiceitemsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems
Show PostInvoiceitemsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostInvoiceitems