Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the types generated from the schema Invoice
Synopsis
- data Invoice = Invoice {
- invoiceAccountCountry :: Maybe Text
- invoiceAccountName :: Maybe Text
- invoiceAccountTaxIds :: Maybe [InvoiceAccountTaxIds'Variants]
- invoiceAmountDue :: Int
- invoiceAmountPaid :: Int
- invoiceAmountRemaining :: Int
- invoiceApplicationFeeAmount :: Maybe Int
- invoiceAttemptCount :: Int
- invoiceAttempted :: Bool
- invoiceAutoAdvance :: Maybe Bool
- invoiceAutomaticTax :: AutomaticTax
- invoiceBillingReason :: Maybe InvoiceBillingReason'
- invoiceCharge :: Maybe InvoiceCharge'Variants
- invoiceCollectionMethod :: Maybe InvoiceCollectionMethod'
- invoiceCreated :: Int
- invoiceCurrency :: Text
- invoiceCustomFields :: Maybe [InvoiceSettingCustomField]
- invoiceCustomer :: Maybe InvoiceCustomer'Variants
- invoiceCustomerAddress :: Maybe InvoiceCustomerAddress'
- invoiceCustomerEmail :: Maybe Text
- invoiceCustomerName :: Maybe Text
- invoiceCustomerPhone :: Maybe Text
- invoiceCustomerShipping :: Maybe InvoiceCustomerShipping'
- invoiceCustomerTaxExempt :: Maybe InvoiceCustomerTaxExempt'
- invoiceCustomerTaxIds :: Maybe [InvoicesResourceInvoiceTaxId]
- invoiceDefaultPaymentMethod :: Maybe InvoiceDefaultPaymentMethod'Variants
- invoiceDefaultSource :: Maybe InvoiceDefaultSource'Variants
- invoiceDefaultTaxRates :: [TaxRate]
- invoiceDescription :: Maybe Text
- invoiceDiscount :: Maybe InvoiceDiscount'
- invoiceDiscounts :: Maybe [InvoiceDiscounts'Variants]
- invoiceDueDate :: Maybe Int
- invoiceEndingBalance :: Maybe Int
- invoiceFooter :: Maybe Text
- invoiceHostedInvoiceUrl :: Maybe Text
- invoiceId :: Maybe Text
- invoiceInvoicePdf :: Maybe Text
- invoiceLastFinalizationError :: Maybe InvoiceLastFinalizationError'
- invoiceLines :: InvoiceLines'
- invoiceLivemode :: Bool
- invoiceMetadata :: Maybe Object
- invoiceNextPaymentAttempt :: Maybe Int
- invoiceNumber :: Maybe Text
- invoiceOnBehalfOf :: Maybe InvoiceOnBehalfOf'Variants
- invoicePaid :: Bool
- invoicePaymentIntent :: Maybe InvoicePaymentIntent'Variants
- invoicePaymentSettings :: InvoicesPaymentSettings
- invoicePeriodEnd :: Int
- invoicePeriodStart :: Int
- invoicePostPaymentCreditNotesAmount :: Int
- invoicePrePaymentCreditNotesAmount :: Int
- invoiceReceiptNumber :: Maybe Text
- invoiceStartingBalance :: Int
- invoiceStatementDescriptor :: Maybe Text
- invoiceStatus :: Maybe InvoiceStatus'
- invoiceStatusTransitions :: InvoicesStatusTransitions
- invoiceSubscription :: Maybe InvoiceSubscription'Variants
- invoiceSubscriptionProrationDate :: Maybe Int
- invoiceSubtotal :: Int
- invoiceTax :: Maybe Int
- invoiceThresholdReason :: Maybe InvoiceThresholdReason
- invoiceTotal :: Int
- invoiceTotalDiscountAmounts :: Maybe [DiscountsResourceDiscountAmount]
- invoiceTotalTaxAmounts :: [InvoiceTaxAmount]
- invoiceTransferData :: Maybe InvoiceTransferData'
- invoiceWebhooksDeliveredAt :: Maybe Int
- mkInvoice :: Int -> Int -> Int -> Int -> Bool -> AutomaticTax -> Int -> Text -> [TaxRate] -> InvoiceLines' -> Bool -> Bool -> InvoicesPaymentSettings -> Int -> Int -> Int -> Int -> Int -> InvoicesStatusTransitions -> Int -> Int -> [InvoiceTaxAmount] -> Invoice
- data InvoiceAccountTaxIds'Variants
- data InvoiceBillingReason'
- = InvoiceBillingReason'Other Value
- | InvoiceBillingReason'Typed Text
- | InvoiceBillingReason'EnumAutomaticPendingInvoiceItemInvoice
- | InvoiceBillingReason'EnumManual
- | InvoiceBillingReason'EnumSubscription
- | InvoiceBillingReason'EnumSubscriptionCreate
- | InvoiceBillingReason'EnumSubscriptionCycle
- | InvoiceBillingReason'EnumSubscriptionThreshold
- | InvoiceBillingReason'EnumSubscriptionUpdate
- | InvoiceBillingReason'EnumUpcoming
- data InvoiceCharge'Variants
- data InvoiceCollectionMethod'
- data InvoiceCustomer'Variants
- data InvoiceCustomerAddress' = InvoiceCustomerAddress' {}
- mkInvoiceCustomerAddress' :: InvoiceCustomerAddress'
- data InvoiceCustomerShipping' = InvoiceCustomerShipping' {}
- mkInvoiceCustomerShipping' :: InvoiceCustomerShipping'
- data InvoiceCustomerTaxExempt'
- data InvoiceDefaultPaymentMethod'Variants
- data InvoiceDefaultSource'Variants
- data InvoiceDiscount' = InvoiceDiscount' {
- invoiceDiscount'CheckoutSession :: Maybe Text
- invoiceDiscount'Coupon :: Maybe Coupon
- invoiceDiscount'Customer :: Maybe InvoiceDiscount'Customer'Variants
- invoiceDiscount'End :: Maybe Int
- invoiceDiscount'Id :: Maybe Text
- invoiceDiscount'Invoice :: Maybe Text
- invoiceDiscount'InvoiceItem :: Maybe Text
- invoiceDiscount'Object :: Maybe InvoiceDiscount'Object'
- invoiceDiscount'PromotionCode :: Maybe InvoiceDiscount'PromotionCode'Variants
- invoiceDiscount'Start :: Maybe Int
- invoiceDiscount'Subscription :: Maybe Text
- mkInvoiceDiscount' :: InvoiceDiscount'
- data InvoiceDiscount'Customer'Variants
- data InvoiceDiscount'Object'
- data InvoiceDiscount'PromotionCode'Variants
- data InvoiceDiscounts'Variants
- data InvoiceLastFinalizationError' = InvoiceLastFinalizationError' {
- invoiceLastFinalizationError'Charge :: Maybe Text
- invoiceLastFinalizationError'Code :: Maybe Text
- invoiceLastFinalizationError'DeclineCode :: Maybe Text
- invoiceLastFinalizationError'DocUrl :: Maybe Text
- invoiceLastFinalizationError'Message :: Maybe Text
- invoiceLastFinalizationError'Param :: Maybe Text
- invoiceLastFinalizationError'PaymentIntent :: Maybe PaymentIntent
- invoiceLastFinalizationError'PaymentMethod :: Maybe PaymentMethod
- invoiceLastFinalizationError'PaymentMethodType :: Maybe Text
- invoiceLastFinalizationError'SetupIntent :: Maybe SetupIntent
- invoiceLastFinalizationError'Source :: Maybe InvoiceLastFinalizationError'Source'
- invoiceLastFinalizationError'Type :: Maybe InvoiceLastFinalizationError'Type'
- mkInvoiceLastFinalizationError' :: InvoiceLastFinalizationError'
- data InvoiceLastFinalizationError'Source' = InvoiceLastFinalizationError'Source' {
- invoiceLastFinalizationError'Source'Account :: Maybe InvoiceLastFinalizationError'Source'Account'Variants
- invoiceLastFinalizationError'Source'AccountHolderName :: Maybe Text
- invoiceLastFinalizationError'Source'AccountHolderType :: Maybe Text
- invoiceLastFinalizationError'Source'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer
- invoiceLastFinalizationError'Source'AchDebit :: Maybe SourceTypeAchDebit
- invoiceLastFinalizationError'Source'AcssDebit :: Maybe SourceTypeAcssDebit
- invoiceLastFinalizationError'Source'AddressCity :: Maybe Text
- invoiceLastFinalizationError'Source'AddressCountry :: Maybe Text
- invoiceLastFinalizationError'Source'AddressLine1 :: Maybe Text
- invoiceLastFinalizationError'Source'AddressLine1Check :: Maybe Text
- invoiceLastFinalizationError'Source'AddressLine2 :: Maybe Text
- invoiceLastFinalizationError'Source'AddressState :: Maybe Text
- invoiceLastFinalizationError'Source'AddressZip :: Maybe Text
- invoiceLastFinalizationError'Source'AddressZipCheck :: Maybe Text
- invoiceLastFinalizationError'Source'Alipay :: Maybe SourceTypeAlipay
- invoiceLastFinalizationError'Source'Amount :: Maybe Int
- invoiceLastFinalizationError'Source'AuBecsDebit :: Maybe SourceTypeAuBecsDebit
- invoiceLastFinalizationError'Source'AvailablePayoutMethods :: Maybe [InvoiceLastFinalizationError'Source'AvailablePayoutMethods']
- invoiceLastFinalizationError'Source'Bancontact :: Maybe SourceTypeBancontact
- invoiceLastFinalizationError'Source'BankName :: Maybe Text
- invoiceLastFinalizationError'Source'Brand :: Maybe Text
- invoiceLastFinalizationError'Source'Card :: Maybe SourceTypeCard
- invoiceLastFinalizationError'Source'CardPresent :: Maybe SourceTypeCardPresent
- invoiceLastFinalizationError'Source'ClientSecret :: Maybe Text
- invoiceLastFinalizationError'Source'CodeVerification :: Maybe SourceCodeVerificationFlow
- invoiceLastFinalizationError'Source'Country :: Maybe Text
- invoiceLastFinalizationError'Source'Created :: Maybe Int
- invoiceLastFinalizationError'Source'Currency :: Maybe Text
- invoiceLastFinalizationError'Source'Customer :: Maybe InvoiceLastFinalizationError'Source'Customer'Variants
- invoiceLastFinalizationError'Source'CvcCheck :: Maybe Text
- invoiceLastFinalizationError'Source'DefaultForCurrency :: Maybe Bool
- invoiceLastFinalizationError'Source'DynamicLast4 :: Maybe Text
- invoiceLastFinalizationError'Source'Eps :: Maybe SourceTypeEps
- invoiceLastFinalizationError'Source'ExpMonth :: Maybe Int
- invoiceLastFinalizationError'Source'ExpYear :: Maybe Int
- invoiceLastFinalizationError'Source'Fingerprint :: Maybe Text
- invoiceLastFinalizationError'Source'Flow :: Maybe Text
- invoiceLastFinalizationError'Source'Funding :: Maybe Text
- invoiceLastFinalizationError'Source'Giropay :: Maybe SourceTypeGiropay
- invoiceLastFinalizationError'Source'Id :: Maybe Text
- invoiceLastFinalizationError'Source'Ideal :: Maybe SourceTypeIdeal
- invoiceLastFinalizationError'Source'Klarna :: Maybe SourceTypeKlarna
- invoiceLastFinalizationError'Source'Last4 :: Maybe Text
- invoiceLastFinalizationError'Source'Livemode :: Maybe Bool
- invoiceLastFinalizationError'Source'Metadata :: Maybe Object
- invoiceLastFinalizationError'Source'Multibanco :: Maybe SourceTypeMultibanco
- invoiceLastFinalizationError'Source'Name :: Maybe Text
- invoiceLastFinalizationError'Source'Object :: Maybe InvoiceLastFinalizationError'Source'Object'
- invoiceLastFinalizationError'Source'Owner :: Maybe InvoiceLastFinalizationError'Source'Owner'
- invoiceLastFinalizationError'Source'P24 :: Maybe SourceTypeP24
- invoiceLastFinalizationError'Source'Receiver :: Maybe SourceReceiverFlow
- invoiceLastFinalizationError'Source'Recipient :: Maybe InvoiceLastFinalizationError'Source'Recipient'Variants
- invoiceLastFinalizationError'Source'Redirect :: Maybe SourceRedirectFlow
- invoiceLastFinalizationError'Source'RoutingNumber :: Maybe Text
- invoiceLastFinalizationError'Source'SepaDebit :: Maybe SourceTypeSepaDebit
- invoiceLastFinalizationError'Source'Sofort :: Maybe SourceTypeSofort
- invoiceLastFinalizationError'Source'SourceOrder :: Maybe SourceOrder
- invoiceLastFinalizationError'Source'StatementDescriptor :: Maybe Text
- invoiceLastFinalizationError'Source'Status :: Maybe Text
- invoiceLastFinalizationError'Source'ThreeDSecure :: Maybe SourceTypeThreeDSecure
- invoiceLastFinalizationError'Source'TokenizationMethod :: Maybe Text
- invoiceLastFinalizationError'Source'Type :: Maybe InvoiceLastFinalizationError'Source'Type'
- invoiceLastFinalizationError'Source'Usage :: Maybe Text
- invoiceLastFinalizationError'Source'Wechat :: Maybe SourceTypeWechat
- mkInvoiceLastFinalizationError'Source' :: InvoiceLastFinalizationError'Source'
- data InvoiceLastFinalizationError'Source'Account'Variants
- data InvoiceLastFinalizationError'Source'AvailablePayoutMethods'
- data InvoiceLastFinalizationError'Source'Customer'Variants
- data InvoiceLastFinalizationError'Source'Object'
- data InvoiceLastFinalizationError'Source'Owner' = InvoiceLastFinalizationError'Source'Owner' {
- invoiceLastFinalizationError'Source'Owner'Address :: Maybe InvoiceLastFinalizationError'Source'Owner'Address'
- invoiceLastFinalizationError'Source'Owner'Email :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'Name :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'Phone :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'VerifiedAddress :: Maybe InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'
- invoiceLastFinalizationError'Source'Owner'VerifiedEmail :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'VerifiedName :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'VerifiedPhone :: Maybe Text
- mkInvoiceLastFinalizationError'Source'Owner' :: InvoiceLastFinalizationError'Source'Owner'
- data InvoiceLastFinalizationError'Source'Owner'Address' = InvoiceLastFinalizationError'Source'Owner'Address' {
- invoiceLastFinalizationError'Source'Owner'Address'City :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'Address'Country :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'Address'Line1 :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'Address'Line2 :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'Address'PostalCode :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'Address'State :: Maybe Text
- mkInvoiceLastFinalizationError'Source'Owner'Address' :: InvoiceLastFinalizationError'Source'Owner'Address'
- data InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' = InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' {
- invoiceLastFinalizationError'Source'Owner'VerifiedAddress'City :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'VerifiedAddress'Country :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'VerifiedAddress'Line1 :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'VerifiedAddress'Line2 :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'VerifiedAddress'PostalCode :: Maybe Text
- invoiceLastFinalizationError'Source'Owner'VerifiedAddress'State :: Maybe Text
- mkInvoiceLastFinalizationError'Source'Owner'VerifiedAddress' :: InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'
- data InvoiceLastFinalizationError'Source'Recipient'Variants
- data InvoiceLastFinalizationError'Source'Type'
- = InvoiceLastFinalizationError'Source'Type'Other Value
- | InvoiceLastFinalizationError'Source'Type'Typed Text
- | InvoiceLastFinalizationError'Source'Type'EnumAchCreditTransfer
- | InvoiceLastFinalizationError'Source'Type'EnumAchDebit
- | InvoiceLastFinalizationError'Source'Type'EnumAcssDebit
- | InvoiceLastFinalizationError'Source'Type'EnumAlipay
- | InvoiceLastFinalizationError'Source'Type'EnumAuBecsDebit
- | InvoiceLastFinalizationError'Source'Type'EnumBancontact
- | InvoiceLastFinalizationError'Source'Type'EnumCard
- | InvoiceLastFinalizationError'Source'Type'EnumCardPresent
- | InvoiceLastFinalizationError'Source'Type'EnumEps
- | InvoiceLastFinalizationError'Source'Type'EnumGiropay
- | InvoiceLastFinalizationError'Source'Type'EnumIdeal
- | InvoiceLastFinalizationError'Source'Type'EnumKlarna
- | InvoiceLastFinalizationError'Source'Type'EnumMultibanco
- | InvoiceLastFinalizationError'Source'Type'EnumP24
- | InvoiceLastFinalizationError'Source'Type'EnumSepaDebit
- | InvoiceLastFinalizationError'Source'Type'EnumSofort
- | InvoiceLastFinalizationError'Source'Type'EnumThreeDSecure
- | InvoiceLastFinalizationError'Source'Type'EnumWechat
- data InvoiceLastFinalizationError'Type'
- = InvoiceLastFinalizationError'Type'Other Value
- | InvoiceLastFinalizationError'Type'Typed Text
- | InvoiceLastFinalizationError'Type'EnumApiConnectionError
- | InvoiceLastFinalizationError'Type'EnumApiError
- | InvoiceLastFinalizationError'Type'EnumAuthenticationError
- | InvoiceLastFinalizationError'Type'EnumCardError
- | InvoiceLastFinalizationError'Type'EnumIdempotencyError
- | InvoiceLastFinalizationError'Type'EnumInvalidRequestError
- | InvoiceLastFinalizationError'Type'EnumRateLimitError
- data InvoiceLines' = InvoiceLines' {}
- mkInvoiceLines' :: [LineItem] -> Bool -> Text -> InvoiceLines'
- data InvoiceOnBehalfOf'Variants
- data InvoicePaymentIntent'Variants
- data InvoiceStatus'
- data InvoiceSubscription'Variants
- data InvoiceTransferData' = InvoiceTransferData' {}
- mkInvoiceTransferData' :: InvoiceTransferData'
- data InvoiceTransferData'Destination'Variants
Documentation
Defines the object schema located at components.schemas.invoice
in the specification.
Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.
They contain invoice items, and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).
If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, when automatic, does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice.
If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice.
Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's minimum allowed charge per currency, the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice.
More details on the customer's credit balance are here.
Related guide: Send Invoices to Customers.
Invoice | |
|
:: Int | |
-> Int | |
-> Int | |
-> Int | |
-> Bool | |
-> AutomaticTax | |
-> Int | |
-> Text | |
-> [TaxRate] | |
-> InvoiceLines' | |
-> Bool | |
-> Bool | |
-> InvoicesPaymentSettings | |
-> Int | |
-> Int | |
-> Int | |
-> Int | |
-> Int | |
-> InvoicesStatusTransitions | |
-> Int | |
-> Int | |
-> [InvoiceTaxAmount] | |
-> Invoice |
Create a new Invoice
with all required fields.
data InvoiceAccountTaxIds'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.account_tax_ids.items.anyOf
in the specification.
InvoiceAccountTaxIds'Text Text | |
InvoiceAccountTaxIds'TaxId TaxId | |
InvoiceAccountTaxIds'DeletedTaxId DeletedTaxId |
Instances
data InvoiceBillingReason' Source #
Defines the enum schema located at components.schemas.invoice.properties.billing_reason
in the specification.
Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.
InvoiceBillingReason'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
InvoiceBillingReason'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
InvoiceBillingReason'EnumAutomaticPendingInvoiceItemInvoice | Represents the JSON value |
InvoiceBillingReason'EnumManual | Represents the JSON value |
InvoiceBillingReason'EnumSubscription | Represents the JSON value |
InvoiceBillingReason'EnumSubscriptionCreate | Represents the JSON value |
InvoiceBillingReason'EnumSubscriptionCycle | Represents the JSON value |
InvoiceBillingReason'EnumSubscriptionThreshold | Represents the JSON value |
InvoiceBillingReason'EnumSubscriptionUpdate | Represents the JSON value |
InvoiceBillingReason'EnumUpcoming | Represents the JSON value |
Instances
Eq InvoiceBillingReason' Source # | |
Defined in StripeAPI.Types.Invoice (==) :: InvoiceBillingReason' -> InvoiceBillingReason' -> Bool # (/=) :: InvoiceBillingReason' -> InvoiceBillingReason' -> Bool # | |
Show InvoiceBillingReason' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceBillingReason' -> ShowS # show :: InvoiceBillingReason' -> String # showList :: [InvoiceBillingReason'] -> ShowS # | |
ToJSON InvoiceBillingReason' Source # | |
Defined in StripeAPI.Types.Invoice toJSON :: InvoiceBillingReason' -> Value # toEncoding :: InvoiceBillingReason' -> Encoding # toJSONList :: [InvoiceBillingReason'] -> Value # toEncodingList :: [InvoiceBillingReason'] -> Encoding # | |
FromJSON InvoiceBillingReason' Source # | |
Defined in StripeAPI.Types.Invoice parseJSON :: Value -> Parser InvoiceBillingReason' # parseJSONList :: Value -> Parser [InvoiceBillingReason'] # |
data InvoiceCharge'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.charge.anyOf
in the specification.
ID of the latest charge generated for this invoice, if any.
Instances
Eq InvoiceCharge'Variants Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceCharge'Variants Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceCharge'Variants -> ShowS # show :: InvoiceCharge'Variants -> String # showList :: [InvoiceCharge'Variants] -> ShowS # | |
ToJSON InvoiceCharge'Variants Source # | |
Defined in StripeAPI.Types.Invoice toJSON :: InvoiceCharge'Variants -> Value # toEncoding :: InvoiceCharge'Variants -> Encoding # toJSONList :: [InvoiceCharge'Variants] -> Value # | |
FromJSON InvoiceCharge'Variants Source # | |
Defined in StripeAPI.Types.Invoice |
data InvoiceCollectionMethod' Source #
Defines the enum schema located at components.schemas.invoice.properties.collection_method
in the specification.
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.
InvoiceCollectionMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
InvoiceCollectionMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
InvoiceCollectionMethod'EnumChargeAutomatically | Represents the JSON value |
InvoiceCollectionMethod'EnumSendInvoice | Represents the JSON value |
Instances
Eq InvoiceCollectionMethod' Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceCollectionMethod' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceCollectionMethod' -> ShowS # show :: InvoiceCollectionMethod' -> String # showList :: [InvoiceCollectionMethod'] -> ShowS # | |
ToJSON InvoiceCollectionMethod' Source # | |
Defined in StripeAPI.Types.Invoice | |
FromJSON InvoiceCollectionMethod' Source # | |
Defined in StripeAPI.Types.Invoice |
data InvoiceCustomer'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.customer.anyOf
in the specification.
The ID of the customer who will be billed.
InvoiceCustomer'Text Text | |
InvoiceCustomer'Customer Customer | |
InvoiceCustomer'DeletedCustomer DeletedCustomer |
Instances
Eq InvoiceCustomer'Variants Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceCustomer'Variants Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceCustomer'Variants -> ShowS # show :: InvoiceCustomer'Variants -> String # showList :: [InvoiceCustomer'Variants] -> ShowS # | |
ToJSON InvoiceCustomer'Variants Source # | |
Defined in StripeAPI.Types.Invoice | |
FromJSON InvoiceCustomer'Variants Source # | |
Defined in StripeAPI.Types.Invoice |
data InvoiceCustomerAddress' Source #
Defines the object schema located at components.schemas.invoice.properties.customer_address.anyOf
in the specification.
The customer\'s address. Until the invoice is finalized, this field will equal \`customer.address\`. Once the invoice is finalized, this field will no longer be updated.
InvoiceCustomerAddress' | |
|
Instances
Eq InvoiceCustomerAddress' Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceCustomerAddress' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceCustomerAddress' -> ShowS # show :: InvoiceCustomerAddress' -> String # showList :: [InvoiceCustomerAddress'] -> ShowS # | |
ToJSON InvoiceCustomerAddress' Source # | |
Defined in StripeAPI.Types.Invoice | |
FromJSON InvoiceCustomerAddress' Source # | |
Defined in StripeAPI.Types.Invoice |
mkInvoiceCustomerAddress' :: InvoiceCustomerAddress' Source #
Create a new InvoiceCustomerAddress'
with all required fields.
data InvoiceCustomerShipping' Source #
Defines the object schema located at components.schemas.invoice.properties.customer_shipping.anyOf
in the specification.
The customer\'s shipping information. Until the invoice is finalized, this field will equal \`customer.shipping\`. Once the invoice is finalized, this field will no longer be updated.
InvoiceCustomerShipping' | |
|
Instances
Eq InvoiceCustomerShipping' Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceCustomerShipping' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceCustomerShipping' -> ShowS # show :: InvoiceCustomerShipping' -> String # showList :: [InvoiceCustomerShipping'] -> ShowS # | |
ToJSON InvoiceCustomerShipping' Source # | |
Defined in StripeAPI.Types.Invoice | |
FromJSON InvoiceCustomerShipping' Source # | |
Defined in StripeAPI.Types.Invoice |
mkInvoiceCustomerShipping' :: InvoiceCustomerShipping' Source #
Create a new InvoiceCustomerShipping'
with all required fields.
data InvoiceCustomerTaxExempt' Source #
Defines the enum schema located at components.schemas.invoice.properties.customer_tax_exempt
in the specification.
The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.
InvoiceCustomerTaxExempt'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
InvoiceCustomerTaxExempt'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
InvoiceCustomerTaxExempt'EnumExempt | Represents the JSON value |
InvoiceCustomerTaxExempt'EnumNone | Represents the JSON value |
InvoiceCustomerTaxExempt'EnumReverse | Represents the JSON value |
Instances
Eq InvoiceCustomerTaxExempt' Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceCustomerTaxExempt' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceCustomerTaxExempt' -> ShowS # show :: InvoiceCustomerTaxExempt' -> String # showList :: [InvoiceCustomerTaxExempt'] -> ShowS # | |
ToJSON InvoiceCustomerTaxExempt' Source # | |
Defined in StripeAPI.Types.Invoice | |
FromJSON InvoiceCustomerTaxExempt' Source # | |
Defined in StripeAPI.Types.Invoice |
data InvoiceDefaultPaymentMethod'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.default_payment_method.anyOf
in the specification.
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.
data InvoiceDefaultSource'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.default_source.anyOf
in the specification.
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.
Instances
data InvoiceDiscount' Source #
Defines the object schema located at components.schemas.invoice.properties.discount.anyOf
in the specification.
Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
InvoiceDiscount' | |
|
Instances
Eq InvoiceDiscount' Source # | |
Defined in StripeAPI.Types.Invoice (==) :: InvoiceDiscount' -> InvoiceDiscount' -> Bool # (/=) :: InvoiceDiscount' -> InvoiceDiscount' -> Bool # | |
Show InvoiceDiscount' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceDiscount' -> ShowS # show :: InvoiceDiscount' -> String # showList :: [InvoiceDiscount'] -> ShowS # | |
ToJSON InvoiceDiscount' Source # | |
Defined in StripeAPI.Types.Invoice toJSON :: InvoiceDiscount' -> Value # toEncoding :: InvoiceDiscount' -> Encoding # toJSONList :: [InvoiceDiscount'] -> Value # toEncodingList :: [InvoiceDiscount'] -> Encoding # | |
FromJSON InvoiceDiscount' Source # | |
Defined in StripeAPI.Types.Invoice parseJSON :: Value -> Parser InvoiceDiscount' # parseJSONList :: Value -> Parser [InvoiceDiscount'] # |
mkInvoiceDiscount' :: InvoiceDiscount' Source #
Create a new InvoiceDiscount'
with all required fields.
data InvoiceDiscount'Customer'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.discount.anyOf.properties.customer.anyOf
in the specification.
The ID of the customer associated with this discount.
InvoiceDiscount'Customer'Text Text | |
InvoiceDiscount'Customer'Customer Customer | |
InvoiceDiscount'Customer'DeletedCustomer DeletedCustomer |
data InvoiceDiscount'Object' Source #
Defines the enum schema located at components.schemas.invoice.properties.discount.anyOf.properties.object
in the specification.
String representing the object's type. Objects of the same type share the same value.
InvoiceDiscount'Object'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
InvoiceDiscount'Object'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
InvoiceDiscount'Object'EnumDiscount | Represents the JSON value |
Instances
Eq InvoiceDiscount'Object' Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceDiscount'Object' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceDiscount'Object' -> ShowS # show :: InvoiceDiscount'Object' -> String # showList :: [InvoiceDiscount'Object'] -> ShowS # | |
ToJSON InvoiceDiscount'Object' Source # | |
Defined in StripeAPI.Types.Invoice | |
FromJSON InvoiceDiscount'Object' Source # | |
Defined in StripeAPI.Types.Invoice |
data InvoiceDiscount'PromotionCode'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.discount.anyOf.properties.promotion_code.anyOf
in the specification.
The promotion code applied to create this discount.
data InvoiceDiscounts'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.discounts.items.anyOf
in the specification.
InvoiceDiscounts'Text Text | |
InvoiceDiscounts'Discount Discount | |
InvoiceDiscounts'DeletedDiscount DeletedDiscount |
Instances
Eq InvoiceDiscounts'Variants Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceDiscounts'Variants Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceDiscounts'Variants -> ShowS # show :: InvoiceDiscounts'Variants -> String # showList :: [InvoiceDiscounts'Variants] -> ShowS # | |
ToJSON InvoiceDiscounts'Variants Source # | |
Defined in StripeAPI.Types.Invoice | |
FromJSON InvoiceDiscounts'Variants Source # | |
Defined in StripeAPI.Types.Invoice |
data InvoiceLastFinalizationError' Source #
Defines the object schema located at components.schemas.invoice.properties.last_finalization_error.anyOf
in the specification.
The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
InvoiceLastFinalizationError' | |
|
Instances
mkInvoiceLastFinalizationError' :: InvoiceLastFinalizationError' Source #
Create a new InvoiceLastFinalizationError'
with all required fields.
data InvoiceLastFinalizationError'Source' Source #
Defines the object schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf
in the specification.
The source object for errors returned on a request involving a source.
InvoiceLastFinalizationError'Source' | |
|
mkInvoiceLastFinalizationError'Source' :: InvoiceLastFinalizationError'Source' Source #
Create a new InvoiceLastFinalizationError'Source'
with all required fields.
data InvoiceLastFinalizationError'Source'Account'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.account.anyOf
in the specification.
The ID of the account that the bank account is associated with.
InvoiceLastFinalizationError'Source'Account'Text Text | |
InvoiceLastFinalizationError'Source'Account'Account Account |
Instances
data InvoiceLastFinalizationError'Source'AvailablePayoutMethods' Source #
Defines the enum schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.available_payout_methods.items
in the specification.
InvoiceLastFinalizationError'Source'AvailablePayoutMethods'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
InvoiceLastFinalizationError'Source'AvailablePayoutMethods'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
InvoiceLastFinalizationError'Source'AvailablePayoutMethods'EnumInstant | Represents the JSON value |
InvoiceLastFinalizationError'Source'AvailablePayoutMethods'EnumStandard | Represents the JSON value |
Instances
data InvoiceLastFinalizationError'Source'Customer'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.customer.anyOf
in the specification.
The ID of the customer that the bank account is associated with.
InvoiceLastFinalizationError'Source'Customer'Text Text | |
InvoiceLastFinalizationError'Source'Customer'Customer Customer | |
InvoiceLastFinalizationError'Source'Customer'DeletedCustomer DeletedCustomer |
Instances
data InvoiceLastFinalizationError'Source'Object' Source #
Defines the enum schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.object
in the specification.
String representing the object's type. Objects of the same type share the same value.
InvoiceLastFinalizationError'Source'Object'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
InvoiceLastFinalizationError'Source'Object'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
InvoiceLastFinalizationError'Source'Object'EnumBankAccount | Represents the JSON value |
data InvoiceLastFinalizationError'Source'Owner' Source #
Defines the object schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.owner.anyOf
in the specification.
Information about the owner of the payment instrument that may be used or required by particular source types.
InvoiceLastFinalizationError'Source'Owner' | |
|
mkInvoiceLastFinalizationError'Source'Owner' :: InvoiceLastFinalizationError'Source'Owner' Source #
Create a new InvoiceLastFinalizationError'Source'Owner'
with all required fields.
data InvoiceLastFinalizationError'Source'Owner'Address' Source #
Defines the object schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.owner.anyOf.properties.address.anyOf
in the specification.
Owner\'s address.
InvoiceLastFinalizationError'Source'Owner'Address' | |
|
Instances
mkInvoiceLastFinalizationError'Source'Owner'Address' :: InvoiceLastFinalizationError'Source'Owner'Address' Source #
Create a new InvoiceLastFinalizationError'Source'Owner'Address'
with all required fields.
data InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' Source #
Defines the object schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.owner.anyOf.properties.verified_address.anyOf
in the specification.
Verified owner\'s address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' | |
|
Instances
mkInvoiceLastFinalizationError'Source'Owner'VerifiedAddress' :: InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' Source #
Create a new InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'
with all required fields.
data InvoiceLastFinalizationError'Source'Recipient'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.recipient.anyOf
in the specification.
The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
InvoiceLastFinalizationError'Source'Recipient'Text Text | |
InvoiceLastFinalizationError'Source'Recipient'Recipient Recipient |
Instances
data InvoiceLastFinalizationError'Source'Type' Source #
Defines the enum schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.source.anyOf.properties.type
in the specification.
The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
data InvoiceLastFinalizationError'Type' Source #
Defines the enum schema located at components.schemas.invoice.properties.last_finalization_error.anyOf.properties.type
in the specification.
The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error`
InvoiceLastFinalizationError'Type'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
InvoiceLastFinalizationError'Type'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
InvoiceLastFinalizationError'Type'EnumApiConnectionError | Represents the JSON value |
InvoiceLastFinalizationError'Type'EnumApiError | Represents the JSON value |
InvoiceLastFinalizationError'Type'EnumAuthenticationError | Represents the JSON value |
InvoiceLastFinalizationError'Type'EnumCardError | Represents the JSON value |
InvoiceLastFinalizationError'Type'EnumIdempotencyError | Represents the JSON value |
InvoiceLastFinalizationError'Type'EnumInvalidRequestError | Represents the JSON value |
InvoiceLastFinalizationError'Type'EnumRateLimitError | Represents the JSON value |
data InvoiceLines' Source #
Defines the object schema located at components.schemas.invoice.properties.lines
in the specification.
The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any.
InvoiceLines' | |
|
Instances
Eq InvoiceLines' Source # | |
Defined in StripeAPI.Types.Invoice (==) :: InvoiceLines' -> InvoiceLines' -> Bool # (/=) :: InvoiceLines' -> InvoiceLines' -> Bool # | |
Show InvoiceLines' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceLines' -> ShowS # show :: InvoiceLines' -> String # showList :: [InvoiceLines'] -> ShowS # | |
ToJSON InvoiceLines' Source # | |
Defined in StripeAPI.Types.Invoice toJSON :: InvoiceLines' -> Value # toEncoding :: InvoiceLines' -> Encoding # toJSONList :: [InvoiceLines'] -> Value # toEncodingList :: [InvoiceLines'] -> Encoding # | |
FromJSON InvoiceLines' Source # | |
Defined in StripeAPI.Types.Invoice parseJSON :: Value -> Parser InvoiceLines' # parseJSONList :: Value -> Parser [InvoiceLines'] # |
Create a new InvoiceLines'
with all required fields.
data InvoiceOnBehalfOf'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.on_behalf_of.anyOf
in the specification.
The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
Instances
Eq InvoiceOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.Invoice | |
Show InvoiceOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceOnBehalfOf'Variants -> ShowS # show :: InvoiceOnBehalfOf'Variants -> String # showList :: [InvoiceOnBehalfOf'Variants] -> ShowS # | |
ToJSON InvoiceOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.Invoice | |
FromJSON InvoiceOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.Invoice |
data InvoicePaymentIntent'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.payment_intent.anyOf
in the specification.
The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
Instances
data InvoiceStatus' Source #
Defines the enum schema located at components.schemas.invoice.properties.status
in the specification.
The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. Learn more
InvoiceStatus'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
InvoiceStatus'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
InvoiceStatus'EnumDeleted | Represents the JSON value |
InvoiceStatus'EnumDraft | Represents the JSON value |
InvoiceStatus'EnumOpen | Represents the JSON value |
InvoiceStatus'EnumPaid | Represents the JSON value |
InvoiceStatus'EnumUncollectible | Represents the JSON value |
InvoiceStatus'EnumVoid | Represents the JSON value |
Instances
Eq InvoiceStatus' Source # | |
Defined in StripeAPI.Types.Invoice (==) :: InvoiceStatus' -> InvoiceStatus' -> Bool # (/=) :: InvoiceStatus' -> InvoiceStatus' -> Bool # | |
Show InvoiceStatus' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceStatus' -> ShowS # show :: InvoiceStatus' -> String # showList :: [InvoiceStatus'] -> ShowS # | |
ToJSON InvoiceStatus' Source # | |
Defined in StripeAPI.Types.Invoice toJSON :: InvoiceStatus' -> Value # toEncoding :: InvoiceStatus' -> Encoding # toJSONList :: [InvoiceStatus'] -> Value # toEncodingList :: [InvoiceStatus'] -> Encoding # | |
FromJSON InvoiceStatus' Source # | |
Defined in StripeAPI.Types.Invoice parseJSON :: Value -> Parser InvoiceStatus' # parseJSONList :: Value -> Parser [InvoiceStatus'] # |
data InvoiceSubscription'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.subscription.anyOf
in the specification.
The subscription that this invoice was prepared for, if any.
Instances
data InvoiceTransferData' Source #
Defines the object schema located at components.schemas.invoice.properties.transfer_data.anyOf
in the specification.
The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.
InvoiceTransferData' | |
|
Instances
Eq InvoiceTransferData' Source # | |
Defined in StripeAPI.Types.Invoice (==) :: InvoiceTransferData' -> InvoiceTransferData' -> Bool # (/=) :: InvoiceTransferData' -> InvoiceTransferData' -> Bool # | |
Show InvoiceTransferData' Source # | |
Defined in StripeAPI.Types.Invoice showsPrec :: Int -> InvoiceTransferData' -> ShowS # show :: InvoiceTransferData' -> String # showList :: [InvoiceTransferData'] -> ShowS # | |
ToJSON InvoiceTransferData' Source # | |
Defined in StripeAPI.Types.Invoice toJSON :: InvoiceTransferData' -> Value # toEncoding :: InvoiceTransferData' -> Encoding # toJSONList :: [InvoiceTransferData'] -> Value # toEncodingList :: [InvoiceTransferData'] -> Encoding # | |
FromJSON InvoiceTransferData' Source # | |
Defined in StripeAPI.Types.Invoice parseJSON :: Value -> Parser InvoiceTransferData' # parseJSONList :: Value -> Parser [InvoiceTransferData'] # |
mkInvoiceTransferData' :: InvoiceTransferData' Source #
Create a new InvoiceTransferData'
with all required fields.
data InvoiceTransferData'Destination'Variants Source #
Defines the oneOf schema located at components.schemas.invoice.properties.transfer_data.anyOf.properties.destination.anyOf
in the specification.
The account where funds from the payment will be transferred to upon payment success.