StripeAPI.Types.Invoice

Contains the types generated from the schema Invoice

Documentation

data Invoice

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.

Constructors

Invoice

Fields

• invoiceAccountCountry :: Maybe Text

  account_country: The country of the business associated with this invoice, most often the business creating the invoice.

  Constraints:

  • Maximum length of 5000
• invoiceAccountName :: Maybe Text

  account_name: The public name of the business associated with this invoice, most often the business creating the invoice.

  Constraints:

  • Maximum length of 5000
• invoiceAccountTaxIds :: Maybe [InvoiceAccountTaxIds'Variants]

  account_tax_ids: The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

• invoiceAmountDue :: Int

  amount_due: Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.

• invoiceAmountPaid :: Int

  amount_paid: The amount, in %s, that was paid.

• invoiceAmountRemaining :: Int

  amount_remaining: The amount remaining, in %s, that is due.

• invoiceApplicationFeeAmount :: Maybe Int

  application_fee_amount: The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.

• invoiceAttemptCount :: Int

  attempt_count: Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.

• invoiceAttempted :: Bool

  attempted: Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.

• invoiceAutoAdvance :: 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.

• invoiceAutomaticTax :: AutomaticTax

  automatic_tax:

• invoiceBillingReason :: Maybe InvoiceBillingReason'

  billing_reason: 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.

• invoiceCharge :: Maybe InvoiceCharge'Variants

  charge: ID of the latest charge generated for this invoice, if any.

• invoiceCollectionMethod :: Maybe InvoiceCollectionMethod'

  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.

• invoiceCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• invoiceCurrency :: Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• invoiceCustomFields :: Maybe [InvoiceSettingCustomField]

  custom_fields: Custom fields displayed on the invoice.

• invoiceCustomer :: Maybe InvoiceCustomer'Variants

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

• invoiceCustomerAddress :: Maybe InvoiceCustomerAddress'

  customer_address: 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.

• invoiceCustomerEmail :: Maybe Text

  customer_email: The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.

  Constraints:

  • Maximum length of 5000
• invoiceCustomerName :: Maybe Text

  customer_name: The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.

  Constraints:

  • Maximum length of 5000
• invoiceCustomerPhone :: Maybe Text

  customer_phone: The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.

  Constraints:

  • Maximum length of 5000
• invoiceCustomerShipping :: Maybe InvoiceCustomerShipping'

  customer_shipping: 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.

• invoiceCustomerTaxExempt :: Maybe InvoiceCustomerTaxExempt'

  customer_tax_exempt: 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.

• invoiceCustomerTaxIds :: Maybe [InvoicesResourceInvoiceTaxId]

  customer_tax_ids: The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.

• invoiceDefaultPaymentMethod :: Maybe InvoiceDefaultPaymentMethod'Variants

  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.

• invoiceDefaultSource :: Maybe InvoiceDefaultSource'Variants

  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.

• invoiceDefaultTaxRates :: [TaxRate]

  default_tax_rates: The tax rates applied to this invoice, if any.

• invoiceDescription :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• invoiceDiscount :: Maybe InvoiceDiscount'

  discount: Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.

• invoiceDiscounts :: Maybe [InvoiceDiscounts'Variants]

  discounts: The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.

• invoiceDueDate :: Maybe Int

  due_date: The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.

• invoiceEndingBalance :: Maybe Int

  ending_balance: Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.

• invoiceFooter :: Maybe Text

  footer: Footer displayed on the invoice.

  Constraints:

  • Maximum length of 5000
• invoiceHostedInvoiceUrl :: Maybe Text

  hosted_invoice_url: The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.

  Constraints:

  • Maximum length of 5000
• invoiceId :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• invoiceInvoicePdf :: Maybe Text

  invoice_pdf: The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError :: Maybe InvoiceLastFinalizationError'

  last_finalization_error: The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.

• invoiceLines :: InvoiceLines'

  lines: 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.

• invoiceLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• invoiceMetadata :: Maybe Object

  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.

• invoiceNextPaymentAttempt :: Maybe Int

  next_payment_attempt: The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.

• invoiceNumber :: Maybe Text

  number: A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.

  Constraints:

  • Maximum length of 5000
• invoiceOnBehalfOf :: Maybe InvoiceOnBehalfOf'Variants

  on_behalf_of: 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.

• invoicePaid :: Bool

  paid: Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.

• invoicePaymentIntent :: Maybe InvoicePaymentIntent'Variants

  payment_intent: 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.

• invoicePaymentSettings :: InvoicesPaymentSettings

  payment_settings:

• invoicePeriodEnd :: Int

  period_end: End of the usage period during which invoice items were added to this invoice.

• invoicePeriodStart :: Int

  period_start: Start of the usage period during which invoice items were added to this invoice.

• invoicePostPaymentCreditNotesAmount :: Int

  post_payment_credit_notes_amount: Total amount of all post-payment credit notes issued for this invoice.

• invoicePrePaymentCreditNotesAmount :: Int

  pre_payment_credit_notes_amount: Total amount of all pre-payment credit notes issued for this invoice.

• invoiceReceiptNumber :: Maybe Text

  receipt_number: This is the transaction number that appears on email receipts sent for this invoice.

  Constraints:

  • Maximum length of 5000
• invoiceStartingBalance :: Int

  starting_balance: Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance.

• invoiceStatementDescriptor :: Maybe Text

  statement_descriptor: Extra information about an invoice for the customer's credit card statement.

  Constraints:

  • Maximum length of 5000
• invoiceStatus :: Maybe InvoiceStatus'

  status: The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. Learn more

• invoiceStatusTransitions :: InvoicesStatusTransitions

  status_transitions:

• invoiceSubscription :: Maybe InvoiceSubscription'Variants

  subscription: The subscription that this invoice was prepared for, if any.

• invoiceSubscriptionProrationDate :: Maybe Int

  subscription_proration_date: Only set for upcoming invoices that preview prorations. The time used to calculate prorations.

• invoiceSubtotal :: Int

  subtotal: Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated

• invoiceTax :: Maybe Int

  tax: The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.

• invoiceThresholdReason :: Maybe InvoiceThresholdReason

  threshold_reason:

• invoiceTotal :: Int

  total: Total after discounts and taxes.

• invoiceTotalDiscountAmounts :: Maybe [DiscountsResourceDiscountAmount]

  total_discount_amounts: The aggregate amounts calculated per discount across all line items.

• invoiceTotalTaxAmounts :: [InvoiceTaxAmount]

  total_tax_amounts: The aggregate amounts calculated per tax rate for all line items.

• invoiceTransferData :: Maybe InvoiceTransferData'

  transfer_data: 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.

• invoiceWebhooksDeliveredAt :: Maybe Int

  webhooks_delivered_at: Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.

Instances

Eq Invoice

Defined in StripeAPI.Types.Invoice

Methods

(==) :: Invoice -> Invoice -> Bool

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

Show Invoice

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> Invoice -> ShowS

show :: Invoice -> String

showList :: [Invoice] -> ShowS

ToJSON Invoice

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: Invoice -> Value

toEncoding :: Invoice -> Encoding

toJSONList :: [Invoice] -> Value

toEncodingList :: [Invoice] -> Encoding

FromJSON Invoice

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser Invoice

parseJSONList :: Value -> Parser [Invoice]

mkInvoice

Arguments

:: Int

invoiceAmountDue

-> Int

invoiceAmountPaid

-> Int

invoiceAmountRemaining

-> Int

invoiceAttemptCount

-> Bool

invoiceAttempted

-> AutomaticTax

invoiceAutomaticTax

-> Int

invoiceCreated

-> Text

invoiceCurrency

-> [TaxRate]

invoiceDefaultTaxRates

-> InvoiceLines'

invoiceLines

-> Bool

invoiceLivemode

-> Bool

invoicePaid

-> InvoicesPaymentSettings

invoicePaymentSettings

-> Int

invoicePeriodEnd

-> Int

invoicePeriodStart

-> Int

invoicePostPaymentCreditNotesAmount

-> Int

invoicePrePaymentCreditNotesAmount

-> Int

invoiceStartingBalance

-> InvoicesStatusTransitions

invoiceStatusTransitions

-> Int

invoiceSubtotal

-> Int

invoiceTotal

-> [InvoiceTaxAmount]

invoiceTotalTaxAmounts

-> Invoice

Create a new Invoice with all required fields.

data InvoiceAccountTaxIds'Variants

Defines the oneOf schema located at components.schemas.invoice.properties.account_tax_ids.items.anyOf in the specification.

Constructors

InvoiceAccountTaxIds'Text Text

InvoiceAccountTaxIds'TaxId TaxId

InvoiceAccountTaxIds'DeletedTaxId DeletedTaxId

Instances

Eq InvoiceAccountTaxIds'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceAccountTaxIds'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoiceAccountTaxIds'Variants -> String

showList :: [InvoiceAccountTaxIds'Variants] -> ShowS

ToJSON InvoiceAccountTaxIds'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceAccountTaxIds'Variants -> Value

toEncoding :: InvoiceAccountTaxIds'Variants -> Encoding

toJSONList :: [InvoiceAccountTaxIds'Variants] -> Value

toEncodingList :: [InvoiceAccountTaxIds'Variants] -> Encoding

FromJSON InvoiceAccountTaxIds'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceAccountTaxIds'Variants

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

data InvoiceBillingReason'

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.

Constructors

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 "automatic_pending_invoice_item_invoice"

InvoiceBillingReason'EnumManual

Represents the JSON value "manual"

InvoiceBillingReason'EnumSubscription

Represents the JSON value "subscription"

InvoiceBillingReason'EnumSubscriptionCreate

Represents the JSON value "subscription_create"

InvoiceBillingReason'EnumSubscriptionCycle

Represents the JSON value "subscription_cycle"

InvoiceBillingReason'EnumSubscriptionThreshold

Represents the JSON value "subscription_threshold"

InvoiceBillingReason'EnumSubscriptionUpdate

Represents the JSON value "subscription_update"

InvoiceBillingReason'EnumUpcoming

Represents the JSON value "upcoming"

Instances

Eq InvoiceBillingReason'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceBillingReason'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceBillingReason' -> ShowS

show :: InvoiceBillingReason' -> String

showList :: [InvoiceBillingReason'] -> ShowS

ToJSON InvoiceBillingReason'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceBillingReason' -> Value

toEncoding :: InvoiceBillingReason' -> Encoding

toJSONList :: [InvoiceBillingReason'] -> Value

toEncodingList :: [InvoiceBillingReason'] -> Encoding

FromJSON InvoiceBillingReason'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceBillingReason'

parseJSONList :: Value -> Parser [InvoiceBillingReason']

data InvoiceCharge'Variants

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.

Constructors

InvoiceCharge'Text Text

InvoiceCharge'Charge Charge

Instances

Eq InvoiceCharge'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceCharge'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoiceCharge'Variants -> String

showList :: [InvoiceCharge'Variants] -> ShowS

ToJSON InvoiceCharge'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceCharge'Variants -> Value

toEncoding :: InvoiceCharge'Variants -> Encoding

toJSONList :: [InvoiceCharge'Variants] -> Value

toEncodingList :: [InvoiceCharge'Variants] -> Encoding

FromJSON InvoiceCharge'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceCharge'Variants

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

data InvoiceCollectionMethod'

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.

Constructors

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 "charge_automatically"

InvoiceCollectionMethod'EnumSendInvoice

Represents the JSON value "send_invoice"

Instances

Eq InvoiceCollectionMethod'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceCollectionMethod'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceCollectionMethod' -> ShowS

show :: InvoiceCollectionMethod' -> String

showList :: [InvoiceCollectionMethod'] -> ShowS

ToJSON InvoiceCollectionMethod'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceCollectionMethod' -> Value

toEncoding :: InvoiceCollectionMethod' -> Encoding

toJSONList :: [InvoiceCollectionMethod'] -> Value

toEncodingList :: [InvoiceCollectionMethod'] -> Encoding

FromJSON InvoiceCollectionMethod'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceCollectionMethod'

parseJSONList :: Value -> Parser [InvoiceCollectionMethod']

data InvoiceCustomer'Variants

Defines the oneOf schema located at components.schemas.invoice.properties.customer.anyOf in the specification.

The ID of the customer who will be billed.

Constructors

InvoiceCustomer'Text Text

InvoiceCustomer'Customer Customer

InvoiceCustomer'DeletedCustomer DeletedCustomer

Instances

Eq InvoiceCustomer'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceCustomer'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoiceCustomer'Variants -> String

showList :: [InvoiceCustomer'Variants] -> ShowS

ToJSON InvoiceCustomer'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceCustomer'Variants -> Value

toEncoding :: InvoiceCustomer'Variants -> Encoding

toJSONList :: [InvoiceCustomer'Variants] -> Value

toEncodingList :: [InvoiceCustomer'Variants] -> Encoding

FromJSON InvoiceCustomer'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceCustomer'Variants

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

data InvoiceCustomerAddress'

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.

Constructors

InvoiceCustomerAddress'

Fields

• invoiceCustomerAddress'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• invoiceCustomerAddress'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• invoiceCustomerAddress'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• invoiceCustomerAddress'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• invoiceCustomerAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• invoiceCustomerAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq InvoiceCustomerAddress'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceCustomerAddress'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceCustomerAddress' -> ShowS

show :: InvoiceCustomerAddress' -> String

showList :: [InvoiceCustomerAddress'] -> ShowS

ToJSON InvoiceCustomerAddress'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceCustomerAddress' -> Value

toEncoding :: InvoiceCustomerAddress' -> Encoding

toJSONList :: [InvoiceCustomerAddress'] -> Value

toEncodingList :: [InvoiceCustomerAddress'] -> Encoding

FromJSON InvoiceCustomerAddress'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceCustomerAddress'

parseJSONList :: Value -> Parser [InvoiceCustomerAddress']

mkInvoiceCustomerAddress' :: InvoiceCustomerAddress'

Create a new InvoiceCustomerAddress' with all required fields.

data InvoiceCustomerShipping'

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.

Constructors

InvoiceCustomerShipping'

Fields

• invoiceCustomerShipping'Address :: Maybe Address

  address:

• invoiceCustomerShipping'Carrier :: Maybe Text

  carrier: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

  Constraints:

  • Maximum length of 5000
• invoiceCustomerShipping'Name :: Maybe Text

  name: Recipient name.

  Constraints:

  • Maximum length of 5000
• invoiceCustomerShipping'Phone :: Maybe Text

  phone: Recipient phone (including extension).

  Constraints:

  • Maximum length of 5000
• invoiceCustomerShipping'TrackingNumber :: Maybe Text

  tracking_number: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

  Constraints:

  • Maximum length of 5000

Instances

Eq InvoiceCustomerShipping'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceCustomerShipping'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceCustomerShipping' -> ShowS

show :: InvoiceCustomerShipping' -> String

showList :: [InvoiceCustomerShipping'] -> ShowS

ToJSON InvoiceCustomerShipping'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceCustomerShipping' -> Value

toEncoding :: InvoiceCustomerShipping' -> Encoding

toJSONList :: [InvoiceCustomerShipping'] -> Value

toEncodingList :: [InvoiceCustomerShipping'] -> Encoding

FromJSON InvoiceCustomerShipping'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceCustomerShipping'

parseJSONList :: Value -> Parser [InvoiceCustomerShipping']

mkInvoiceCustomerShipping' :: InvoiceCustomerShipping'

Create a new InvoiceCustomerShipping' with all required fields.

data InvoiceCustomerTaxExempt'

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.

Constructors

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 "exempt"

InvoiceCustomerTaxExempt'EnumNone

Represents the JSON value "none"

InvoiceCustomerTaxExempt'EnumReverse

Represents the JSON value "reverse"

Instances

Eq InvoiceCustomerTaxExempt'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceCustomerTaxExempt'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceCustomerTaxExempt' -> ShowS

show :: InvoiceCustomerTaxExempt' -> String

showList :: [InvoiceCustomerTaxExempt'] -> ShowS

ToJSON InvoiceCustomerTaxExempt'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceCustomerTaxExempt' -> Value

toEncoding :: InvoiceCustomerTaxExempt' -> Encoding

toJSONList :: [InvoiceCustomerTaxExempt'] -> Value

toEncodingList :: [InvoiceCustomerTaxExempt'] -> Encoding

FromJSON InvoiceCustomerTaxExempt'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceCustomerTaxExempt'

parseJSONList :: Value -> Parser [InvoiceCustomerTaxExempt']

data InvoiceDefaultPaymentMethod'Variants

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.

Constructors

InvoiceDefaultPaymentMethod'Text Text

InvoiceDefaultPaymentMethod'PaymentMethod PaymentMethod

Instances

Eq InvoiceDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoiceDefaultPaymentMethod'Variants -> String

showList :: [InvoiceDefaultPaymentMethod'Variants] -> ShowS

ToJSON InvoiceDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceDefaultPaymentMethod'Variants -> Value

toEncoding :: InvoiceDefaultPaymentMethod'Variants -> Encoding

toJSONList :: [InvoiceDefaultPaymentMethod'Variants] -> Value

toEncodingList :: [InvoiceDefaultPaymentMethod'Variants] -> Encoding

FromJSON InvoiceDefaultPaymentMethod'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceDefaultPaymentMethod'Variants

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

data InvoiceDefaultSource'Variants

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.

Constructors

InvoiceDefaultSource'Text Text

InvoiceDefaultSource'AlipayAccount AlipayAccount

InvoiceDefaultSource'BankAccount BankAccount

InvoiceDefaultSource'BitcoinReceiver BitcoinReceiver

InvoiceDefaultSource'Card Card

InvoiceDefaultSource'Source Source

Instances

Eq InvoiceDefaultSource'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceDefaultSource'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoiceDefaultSource'Variants -> String

showList :: [InvoiceDefaultSource'Variants] -> ShowS

ToJSON InvoiceDefaultSource'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceDefaultSource'Variants -> Value

toEncoding :: InvoiceDefaultSource'Variants -> Encoding

toJSONList :: [InvoiceDefaultSource'Variants] -> Value

toEncodingList :: [InvoiceDefaultSource'Variants] -> Encoding

FromJSON InvoiceDefaultSource'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceDefaultSource'Variants

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

data InvoiceDiscount'

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.

Constructors

InvoiceDiscount'

Fields

• invoiceDiscount'CheckoutSession :: Maybe Text

  checkout_session: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

  Constraints:

  • Maximum length of 5000
• invoiceDiscount'Coupon :: Maybe Coupon

  coupon: A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to invoices or orders. Coupons do not work with conventional one-off charges.

• invoiceDiscount'Customer :: Maybe InvoiceDiscount'Customer'Variants

  customer: The ID of the customer associated with this discount.

• invoiceDiscount'End :: Maybe Int

  end: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.

• invoiceDiscount'Id :: Maybe Text

  id: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.

  Constraints:

  • Maximum length of 5000
• invoiceDiscount'Invoice :: Maybe Text

  invoice: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.

  Constraints:

  • Maximum length of 5000
• invoiceDiscount'InvoiceItem :: Maybe Text

  invoice_item: The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

  Constraints:

  • Maximum length of 5000
• invoiceDiscount'Object :: Maybe InvoiceDiscount'Object'

  object: String representing the object's type. Objects of the same type share the same value.

• invoiceDiscount'PromotionCode :: Maybe InvoiceDiscount'PromotionCode'Variants

  promotion_code: The promotion code applied to create this discount.

• invoiceDiscount'Start :: Maybe Int

  start: Date that the coupon was applied.

• invoiceDiscount'Subscription :: Maybe Text

  subscription: The subscription that this coupon is applied to, if it is applied to a particular subscription.

  Constraints:

  • Maximum length of 5000

Instances

Eq InvoiceDiscount'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceDiscount'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceDiscount' -> ShowS

show :: InvoiceDiscount' -> String

showList :: [InvoiceDiscount'] -> ShowS

ToJSON InvoiceDiscount'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceDiscount' -> Value

toEncoding :: InvoiceDiscount' -> Encoding

toJSONList :: [InvoiceDiscount'] -> Value

toEncodingList :: [InvoiceDiscount'] -> Encoding

FromJSON InvoiceDiscount'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceDiscount'

parseJSONList :: Value -> Parser [InvoiceDiscount']

mkInvoiceDiscount' :: InvoiceDiscount'

Create a new InvoiceDiscount' with all required fields.

data InvoiceDiscount'Customer'Variants

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.

Constructors

InvoiceDiscount'Customer'Text Text

InvoiceDiscount'Customer'Customer Customer

InvoiceDiscount'Customer'DeletedCustomer DeletedCustomer

Instances

Eq InvoiceDiscount'Customer'Variants

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceDiscount'Customer'Variants -> InvoiceDiscount'Customer'Variants -> Bool

(/=) :: InvoiceDiscount'Customer'Variants -> InvoiceDiscount'Customer'Variants -> Bool

Show InvoiceDiscount'Customer'Variants

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceDiscount'Customer'Variants -> ShowS

show :: InvoiceDiscount'Customer'Variants -> String

showList :: [InvoiceDiscount'Customer'Variants] -> ShowS

ToJSON InvoiceDiscount'Customer'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceDiscount'Customer'Variants -> Value

toEncoding :: InvoiceDiscount'Customer'Variants -> Encoding

toJSONList :: [InvoiceDiscount'Customer'Variants] -> Value

toEncodingList :: [InvoiceDiscount'Customer'Variants] -> Encoding

FromJSON InvoiceDiscount'Customer'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceDiscount'Customer'Variants

parseJSONList :: Value -> Parser [InvoiceDiscount'Customer'Variants]

data InvoiceDiscount'Object'

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.

Constructors

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 "discount"

Instances

Eq InvoiceDiscount'Object'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceDiscount'Object' -> InvoiceDiscount'Object' -> Bool

(/=) :: InvoiceDiscount'Object' -> InvoiceDiscount'Object' -> Bool

Show InvoiceDiscount'Object'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceDiscount'Object' -> ShowS

show :: InvoiceDiscount'Object' -> String

showList :: [InvoiceDiscount'Object'] -> ShowS

ToJSON InvoiceDiscount'Object'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceDiscount'Object' -> Value

toEncoding :: InvoiceDiscount'Object' -> Encoding

toJSONList :: [InvoiceDiscount'Object'] -> Value

toEncodingList :: [InvoiceDiscount'Object'] -> Encoding

FromJSON InvoiceDiscount'Object'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceDiscount'Object'

parseJSONList :: Value -> Parser [InvoiceDiscount'Object']

data InvoiceDiscount'PromotionCode'Variants

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.

Constructors

InvoiceDiscount'PromotionCode'Text Text

InvoiceDiscount'PromotionCode'PromotionCode PromotionCode

Instances

Eq InvoiceDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceDiscount'PromotionCode'Variants -> InvoiceDiscount'PromotionCode'Variants -> Bool

(/=) :: InvoiceDiscount'PromotionCode'Variants -> InvoiceDiscount'PromotionCode'Variants -> Bool

Show InvoiceDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceDiscount'PromotionCode'Variants -> ShowS

show :: InvoiceDiscount'PromotionCode'Variants -> String

showList :: [InvoiceDiscount'PromotionCode'Variants] -> ShowS

ToJSON InvoiceDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceDiscount'PromotionCode'Variants -> Value

toEncoding :: InvoiceDiscount'PromotionCode'Variants -> Encoding

toJSONList :: [InvoiceDiscount'PromotionCode'Variants] -> Value

toEncodingList :: [InvoiceDiscount'PromotionCode'Variants] -> Encoding

FromJSON InvoiceDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceDiscount'PromotionCode'Variants

parseJSONList :: Value -> Parser [InvoiceDiscount'PromotionCode'Variants]

data InvoiceDiscounts'Variants

Defines the oneOf schema located at components.schemas.invoice.properties.discounts.items.anyOf in the specification.

Constructors

InvoiceDiscounts'Text Text

InvoiceDiscounts'Discount Discount

InvoiceDiscounts'DeletedDiscount DeletedDiscount

Instances

Eq InvoiceDiscounts'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceDiscounts'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoiceDiscounts'Variants -> String

showList :: [InvoiceDiscounts'Variants] -> ShowS

ToJSON InvoiceDiscounts'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceDiscounts'Variants -> Value

toEncoding :: InvoiceDiscounts'Variants -> Encoding

toJSONList :: [InvoiceDiscounts'Variants] -> Value

toEncodingList :: [InvoiceDiscounts'Variants] -> Encoding

FromJSON InvoiceDiscounts'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceDiscounts'Variants

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

data InvoiceLastFinalizationError'

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.

Constructors

InvoiceLastFinalizationError'

Fields

• invoiceLastFinalizationError'Charge :: Maybe Text

  charge: For card errors, the ID of the failed charge.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Code :: Maybe Text

  code: For some errors that could be handled programmatically, a short string indicating the error code reported.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'DeclineCode :: Maybe Text

  decline_code: For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'DocUrl :: Maybe Text

  doc_url: A URL to more information about the error code reported.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Message :: Maybe Text

  message: A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

  Constraints:

  • Maximum length of 40000
• invoiceLastFinalizationError'Param :: Maybe Text

  param: If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'PaymentIntent :: Maybe PaymentIntent

  payment_intent: A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

  A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

  Related guide: Payment Intents API.

• invoiceLastFinalizationError'PaymentMethod :: Maybe PaymentMethod

  payment_method: PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments.

  Related guides: Payment Methods and More Payment Scenarios.

• invoiceLastFinalizationError'PaymentMethodType :: Maybe Text

  payment_method_type: If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'SetupIntent :: Maybe SetupIntent

  setup_intent: A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

  Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple statuses as it guides you through the setup process.

  Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions may need to be run through Strong Customer Authentication at the time of payment method collection in order to streamline later off-session payments. If the SetupIntent is used with a Customer, upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.

  By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time.

  Related guide: Setup Intents API.

• invoiceLastFinalizationError'Source :: Maybe InvoiceLastFinalizationError'Source'

  source: The source object for errors returned on a request involving a source.

• invoiceLastFinalizationError'Type :: Maybe InvoiceLastFinalizationError'Type'

  type: 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`

Instances

Eq InvoiceLastFinalizationError'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceLastFinalizationError'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError' -> ShowS

show :: InvoiceLastFinalizationError' -> String

showList :: [InvoiceLastFinalizationError'] -> ShowS

ToJSON InvoiceLastFinalizationError'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError' -> Value

toEncoding :: InvoiceLastFinalizationError' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'] -> Encoding

FromJSON InvoiceLastFinalizationError'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError']

mkInvoiceLastFinalizationError' :: InvoiceLastFinalizationError'

Create a new InvoiceLastFinalizationError' with all required fields.

data InvoiceLastFinalizationError'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.

Constructors

InvoiceLastFinalizationError'Source'

Fields

• invoiceLastFinalizationError'Source'Account :: Maybe InvoiceLastFinalizationError'Source'Account'Variants

  account: The ID of the account that the bank account is associated with.

• invoiceLastFinalizationError'Source'AccountHolderName :: Maybe Text

  account_holder_name: The name of the person or business that owns the bank account.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AccountHolderType :: Maybe Text

  account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer

  ach_credit_transfer

• invoiceLastFinalizationError'Source'AchDebit :: Maybe SourceTypeAchDebit

  ach_debit

• invoiceLastFinalizationError'Source'AcssDebit :: Maybe SourceTypeAcssDebit

  acss_debit

• invoiceLastFinalizationError'Source'AddressCity :: Maybe Text

  address_city: City/District/Suburb/Town/Village.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AddressCountry :: Maybe Text

  address_country: Billing address country, if provided when creating card.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AddressLine1 :: Maybe Text

  address_line1: Address line 1 (Street address/PO Box/Company name).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AddressLine1Check :: Maybe Text

  address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AddressLine2 :: Maybe Text

  address_line2: Address line 2 (Apartment/Suite/Unit/Building).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'AddressZipCheck :: Maybe Text

  address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Alipay :: Maybe SourceTypeAlipay

  alipay

• invoiceLastFinalizationError'Source'Amount :: Maybe Int

  amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.

• invoiceLastFinalizationError'Source'AuBecsDebit :: Maybe SourceTypeAuBecsDebit

  au_becs_debit

• invoiceLastFinalizationError'Source'AvailablePayoutMethods :: Maybe [InvoiceLastFinalizationError'Source'AvailablePayoutMethods']

  available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

• invoiceLastFinalizationError'Source'Bancontact :: Maybe SourceTypeBancontact

  bancontact

• invoiceLastFinalizationError'Source'BankName :: Maybe Text

  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Brand :: Maybe Text

  brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Card :: Maybe SourceTypeCard

  card

• invoiceLastFinalizationError'Source'CardPresent :: Maybe SourceTypeCardPresent

  card_present

• invoiceLastFinalizationError'Source'ClientSecret :: Maybe Text

  client_secret: The client secret of the source. Used for client-side retrieval using a publishable key.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'CodeVerification :: Maybe SourceCodeVerificationFlow

  code_verification:

• invoiceLastFinalizationError'Source'Country :: Maybe Text

  country: Two-letter ISO code representing the country the bank account is located in.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Created :: Maybe Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• invoiceLastFinalizationError'Source'Currency :: Maybe Text

  currency: Three-letter ISO code for the currency paid out to the bank account.

• invoiceLastFinalizationError'Source'Customer :: Maybe InvoiceLastFinalizationError'Source'Customer'Variants

  customer: The ID of the customer that the bank account is associated with.

• invoiceLastFinalizationError'Source'CvcCheck :: Maybe Text

  cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'DefaultForCurrency :: Maybe Bool

  default_for_currency: Whether this bank account is the default external account for its currency.

• invoiceLastFinalizationError'Source'DynamicLast4 :: Maybe Text

  dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Eps :: Maybe SourceTypeEps

  eps

• invoiceLastFinalizationError'Source'ExpMonth :: Maybe Int

  exp_month: Two-digit number representing the card's expiration month.

• invoiceLastFinalizationError'Source'ExpYear :: Maybe Int

  exp_year: Four-digit number representing the card's expiration year.

• invoiceLastFinalizationError'Source'Fingerprint :: Maybe Text

  fingerprint: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Flow :: Maybe Text

  flow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Funding :: Maybe Text

  funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Giropay :: Maybe SourceTypeGiropay

  giropay

• invoiceLastFinalizationError'Source'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Ideal :: Maybe SourceTypeIdeal

  ideal

• invoiceLastFinalizationError'Source'Klarna :: Maybe SourceTypeKlarna

  klarna

• invoiceLastFinalizationError'Source'Last4 :: Maybe Text

  last4: The last four digits of the bank account number.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Livemode :: Maybe Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• invoiceLastFinalizationError'Source'Metadata :: Maybe Object

  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.

• invoiceLastFinalizationError'Source'Multibanco :: Maybe SourceTypeMultibanco

  multibanco

• invoiceLastFinalizationError'Source'Name :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Object :: Maybe InvoiceLastFinalizationError'Source'Object'

  object: String representing the object's type. Objects of the same type share the same value.

• invoiceLastFinalizationError'Source'Owner :: Maybe InvoiceLastFinalizationError'Source'Owner'

  owner: Information about the owner of the payment instrument that may be used or required by particular source types.

• invoiceLastFinalizationError'Source'P24 :: Maybe SourceTypeP24

  p24

• invoiceLastFinalizationError'Source'Receiver :: Maybe SourceReceiverFlow

  receiver:

• invoiceLastFinalizationError'Source'Recipient :: Maybe InvoiceLastFinalizationError'Source'Recipient'Variants

  recipient: 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'Redirect :: Maybe SourceRedirectFlow

  redirect:

• invoiceLastFinalizationError'Source'RoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'SepaDebit :: Maybe SourceTypeSepaDebit

  sepa_debit

• invoiceLastFinalizationError'Source'Sofort :: Maybe SourceTypeSofort

  sofort

• invoiceLastFinalizationError'Source'SourceOrder :: Maybe SourceOrder

  source_order:

• invoiceLastFinalizationError'Source'StatementDescriptor :: Maybe Text

  statement_descriptor: Extra information about a source. This will appear on your customer's statement every time you charge the source.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Status :: Maybe Text

  status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

  For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'ThreeDSecure :: Maybe SourceTypeThreeDSecure

  three_d_secure

• invoiceLastFinalizationError'Source'TokenizationMethod :: Maybe Text

  tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Type :: Maybe InvoiceLastFinalizationError'Source'Type'

  type: 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.

• invoiceLastFinalizationError'Source'Usage :: Maybe Text

  usage: Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Wechat :: Maybe SourceTypeWechat

  wechat

Instances

Eq InvoiceLastFinalizationError'Source'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source' -> InvoiceLastFinalizationError'Source' -> Bool

(/=) :: InvoiceLastFinalizationError'Source' -> InvoiceLastFinalizationError'Source' -> Bool

Show InvoiceLastFinalizationError'Source'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source' -> ShowS

show :: InvoiceLastFinalizationError'Source' -> String

showList :: [InvoiceLastFinalizationError'Source'] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source' -> Value

toEncoding :: InvoiceLastFinalizationError'Source' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source']

mkInvoiceLastFinalizationError'Source' :: InvoiceLastFinalizationError'Source'

Create a new InvoiceLastFinalizationError'Source' with all required fields.

data InvoiceLastFinalizationError'Source'Account'Variants

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.

Constructors

InvoiceLastFinalizationError'Source'Account'Text Text

InvoiceLastFinalizationError'Source'Account'Account Account

Instances

Eq InvoiceLastFinalizationError'Source'Account'Variants

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'Account'Variants -> InvoiceLastFinalizationError'Source'Account'Variants -> Bool

(/=) :: InvoiceLastFinalizationError'Source'Account'Variants -> InvoiceLastFinalizationError'Source'Account'Variants -> Bool

Show InvoiceLastFinalizationError'Source'Account'Variants

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'Account'Variants -> ShowS

show :: InvoiceLastFinalizationError'Source'Account'Variants -> String

showList :: [InvoiceLastFinalizationError'Source'Account'Variants] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'Account'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'Account'Variants -> Value

toEncoding :: InvoiceLastFinalizationError'Source'Account'Variants -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'Account'Variants] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'Account'Variants] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'Account'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'Account'Variants

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'Account'Variants]

data InvoiceLastFinalizationError'Source'AvailablePayoutMethods'

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.

Constructors

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 "instant"

InvoiceLastFinalizationError'Source'AvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq InvoiceLastFinalizationError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'AvailablePayoutMethods' -> InvoiceLastFinalizationError'Source'AvailablePayoutMethods' -> Bool

(/=) :: InvoiceLastFinalizationError'Source'AvailablePayoutMethods' -> InvoiceLastFinalizationError'Source'AvailablePayoutMethods' -> Bool

Show InvoiceLastFinalizationError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'AvailablePayoutMethods' -> ShowS

show :: InvoiceLastFinalizationError'Source'AvailablePayoutMethods' -> String

showList :: [InvoiceLastFinalizationError'Source'AvailablePayoutMethods'] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'AvailablePayoutMethods' -> Value

toEncoding :: InvoiceLastFinalizationError'Source'AvailablePayoutMethods' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'AvailablePayoutMethods'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'AvailablePayoutMethods'] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'AvailablePayoutMethods'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'AvailablePayoutMethods']

data InvoiceLastFinalizationError'Source'Customer'Variants

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.

Constructors

InvoiceLastFinalizationError'Source'Customer'Text Text

InvoiceLastFinalizationError'Source'Customer'Customer Customer

InvoiceLastFinalizationError'Source'Customer'DeletedCustomer DeletedCustomer

Instances

Eq InvoiceLastFinalizationError'Source'Customer'Variants

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'Customer'Variants -> InvoiceLastFinalizationError'Source'Customer'Variants -> Bool

(/=) :: InvoiceLastFinalizationError'Source'Customer'Variants -> InvoiceLastFinalizationError'Source'Customer'Variants -> Bool

Show InvoiceLastFinalizationError'Source'Customer'Variants

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'Customer'Variants -> ShowS

show :: InvoiceLastFinalizationError'Source'Customer'Variants -> String

showList :: [InvoiceLastFinalizationError'Source'Customer'Variants] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'Customer'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'Customer'Variants -> Value

toEncoding :: InvoiceLastFinalizationError'Source'Customer'Variants -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'Customer'Variants] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'Customer'Variants] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'Customer'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'Customer'Variants

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'Customer'Variants]

data InvoiceLastFinalizationError'Source'Object'

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.

Constructors

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 "bank_account"

Instances

Eq InvoiceLastFinalizationError'Source'Object'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'Object' -> InvoiceLastFinalizationError'Source'Object' -> Bool

(/=) :: InvoiceLastFinalizationError'Source'Object' -> InvoiceLastFinalizationError'Source'Object' -> Bool

Show InvoiceLastFinalizationError'Source'Object'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'Object' -> ShowS

show :: InvoiceLastFinalizationError'Source'Object' -> String

showList :: [InvoiceLastFinalizationError'Source'Object'] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'Object'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'Object' -> Value

toEncoding :: InvoiceLastFinalizationError'Source'Object' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'Object'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'Object'] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'Object'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'Object'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'Object']

data InvoiceLastFinalizationError'Source'Owner'

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.

Constructors

InvoiceLastFinalizationError'Source'Owner'

Fields

• invoiceLastFinalizationError'Source'Owner'Address :: Maybe InvoiceLastFinalizationError'Source'Owner'Address'

  address: Owner's address.

• invoiceLastFinalizationError'Source'Owner'Email :: Maybe Text

  email: Owner's email address.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'Name :: Maybe Text

  name: Owner's full name.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'Phone :: Maybe Text

  phone: Owner's phone number (including extension).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'VerifiedAddress :: Maybe InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

  verified_address: 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'VerifiedEmail :: Maybe Text

  verified_email: Verified owner's email 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.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'VerifiedName :: Maybe Text

  verified_name: Verified owner's full name. 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.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'VerifiedPhone :: Maybe Text

  verified_phone: Verified owner's phone number (including extension). 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.

  Constraints:

  • Maximum length of 5000

Instances

Eq InvoiceLastFinalizationError'Source'Owner'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'Owner' -> InvoiceLastFinalizationError'Source'Owner' -> Bool

(/=) :: InvoiceLastFinalizationError'Source'Owner' -> InvoiceLastFinalizationError'Source'Owner' -> Bool

Show InvoiceLastFinalizationError'Source'Owner'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'Owner' -> ShowS

show :: InvoiceLastFinalizationError'Source'Owner' -> String

showList :: [InvoiceLastFinalizationError'Source'Owner'] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'Owner'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'Owner' -> Value

toEncoding :: InvoiceLastFinalizationError'Source'Owner' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'Owner'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'Owner'] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'Owner'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'Owner'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'Owner']

mkInvoiceLastFinalizationError'Source'Owner' :: InvoiceLastFinalizationError'Source'Owner'

Create a new InvoiceLastFinalizationError'Source'Owner' with all required fields.

data InvoiceLastFinalizationError'Source'Owner'Address'

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.

Constructors

InvoiceLastFinalizationError'Source'Owner'Address'

Fields

• invoiceLastFinalizationError'Source'Owner'Address'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'Address'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'Address'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'Address'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'Address'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'Address'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq InvoiceLastFinalizationError'Source'Owner'Address'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'Owner'Address' -> InvoiceLastFinalizationError'Source'Owner'Address' -> Bool

(/=) :: InvoiceLastFinalizationError'Source'Owner'Address' -> InvoiceLastFinalizationError'Source'Owner'Address' -> Bool

Show InvoiceLastFinalizationError'Source'Owner'Address'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'Owner'Address' -> ShowS

show :: InvoiceLastFinalizationError'Source'Owner'Address' -> String

showList :: [InvoiceLastFinalizationError'Source'Owner'Address'] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'Owner'Address'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'Owner'Address' -> Value

toEncoding :: InvoiceLastFinalizationError'Source'Owner'Address' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'Owner'Address'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'Owner'Address'] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'Owner'Address'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'Owner'Address'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'Owner'Address']

mkInvoiceLastFinalizationError'Source'Owner'Address' :: InvoiceLastFinalizationError'Source'Owner'Address'

Create a new InvoiceLastFinalizationError'Source'Owner'Address' with all required fields.

data InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

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.

Constructors

InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

Fields

• invoiceLastFinalizationError'Source'Owner'VerifiedAddress'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'VerifiedAddress'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'VerifiedAddress'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'VerifiedAddress'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'VerifiedAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• invoiceLastFinalizationError'Source'Owner'VerifiedAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' -> InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' -> Bool

(/=) :: InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' -> InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' -> Bool

Show InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' -> ShowS

show :: InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' -> String

showList :: [InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' -> Value

toEncoding :: InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'Owner'VerifiedAddress']

mkInvoiceLastFinalizationError'Source'Owner'VerifiedAddress' :: InvoiceLastFinalizationError'Source'Owner'VerifiedAddress'

Create a new InvoiceLastFinalizationError'Source'Owner'VerifiedAddress' with all required fields.

data InvoiceLastFinalizationError'Source'Recipient'Variants

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.

Constructors

InvoiceLastFinalizationError'Source'Recipient'Text Text

InvoiceLastFinalizationError'Source'Recipient'Recipient Recipient

Instances

Eq InvoiceLastFinalizationError'Source'Recipient'Variants

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'Recipient'Variants -> InvoiceLastFinalizationError'Source'Recipient'Variants -> Bool

(/=) :: InvoiceLastFinalizationError'Source'Recipient'Variants -> InvoiceLastFinalizationError'Source'Recipient'Variants -> Bool

Show InvoiceLastFinalizationError'Source'Recipient'Variants

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'Recipient'Variants -> ShowS

show :: InvoiceLastFinalizationError'Source'Recipient'Variants -> String

showList :: [InvoiceLastFinalizationError'Source'Recipient'Variants] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'Recipient'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'Recipient'Variants -> Value

toEncoding :: InvoiceLastFinalizationError'Source'Recipient'Variants -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'Recipient'Variants] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'Recipient'Variants] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'Recipient'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'Recipient'Variants

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'Recipient'Variants]

data InvoiceLastFinalizationError'Source'Type'

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.

Constructors

InvoiceLastFinalizationError'Source'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'Source'Type'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

InvoiceLastFinalizationError'Source'Type'EnumAchCreditTransfer

Represents the JSON value "ach_credit_transfer"

InvoiceLastFinalizationError'Source'Type'EnumAchDebit

Represents the JSON value "ach_debit"

InvoiceLastFinalizationError'Source'Type'EnumAcssDebit

Represents the JSON value "acss_debit"

InvoiceLastFinalizationError'Source'Type'EnumAlipay

Represents the JSON value "alipay"

InvoiceLastFinalizationError'Source'Type'EnumAuBecsDebit

Represents the JSON value "au_becs_debit"

InvoiceLastFinalizationError'Source'Type'EnumBancontact

Represents the JSON value "bancontact"

InvoiceLastFinalizationError'Source'Type'EnumCard

Represents the JSON value "card"

InvoiceLastFinalizationError'Source'Type'EnumCardPresent

Represents the JSON value "card_present"

InvoiceLastFinalizationError'Source'Type'EnumEps

Represents the JSON value "eps"

InvoiceLastFinalizationError'Source'Type'EnumGiropay

Represents the JSON value "giropay"

InvoiceLastFinalizationError'Source'Type'EnumIdeal

Represents the JSON value "ideal"

InvoiceLastFinalizationError'Source'Type'EnumKlarna

Represents the JSON value "klarna"

InvoiceLastFinalizationError'Source'Type'EnumMultibanco

Represents the JSON value "multibanco"

InvoiceLastFinalizationError'Source'Type'EnumP24

Represents the JSON value "p24"

InvoiceLastFinalizationError'Source'Type'EnumSepaDebit

Represents the JSON value "sepa_debit"

InvoiceLastFinalizationError'Source'Type'EnumSofort

Represents the JSON value "sofort"

InvoiceLastFinalizationError'Source'Type'EnumThreeDSecure

Represents the JSON value "three_d_secure"

InvoiceLastFinalizationError'Source'Type'EnumWechat

Represents the JSON value "wechat"

Instances

Eq InvoiceLastFinalizationError'Source'Type'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Source'Type' -> InvoiceLastFinalizationError'Source'Type' -> Bool

(/=) :: InvoiceLastFinalizationError'Source'Type' -> InvoiceLastFinalizationError'Source'Type' -> Bool

Show InvoiceLastFinalizationError'Source'Type'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Source'Type' -> ShowS

show :: InvoiceLastFinalizationError'Source'Type' -> String

showList :: [InvoiceLastFinalizationError'Source'Type'] -> ShowS

ToJSON InvoiceLastFinalizationError'Source'Type'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Source'Type' -> Value

toEncoding :: InvoiceLastFinalizationError'Source'Type' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Source'Type'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Source'Type'] -> Encoding

FromJSON InvoiceLastFinalizationError'Source'Type'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Source'Type'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Source'Type']

data InvoiceLastFinalizationError'Type'

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`

Constructors

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 "api_connection_error"

InvoiceLastFinalizationError'Type'EnumApiError

Represents the JSON value "api_error"

InvoiceLastFinalizationError'Type'EnumAuthenticationError

Represents the JSON value "authentication_error"

InvoiceLastFinalizationError'Type'EnumCardError

Represents the JSON value "card_error"

InvoiceLastFinalizationError'Type'EnumIdempotencyError

Represents the JSON value "idempotency_error"

InvoiceLastFinalizationError'Type'EnumInvalidRequestError

Represents the JSON value "invalid_request_error"

InvoiceLastFinalizationError'Type'EnumRateLimitError

Represents the JSON value "rate_limit_error"

Instances

Eq InvoiceLastFinalizationError'Type'

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceLastFinalizationError'Type' -> InvoiceLastFinalizationError'Type' -> Bool

(/=) :: InvoiceLastFinalizationError'Type' -> InvoiceLastFinalizationError'Type' -> Bool

Show InvoiceLastFinalizationError'Type'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLastFinalizationError'Type' -> ShowS

show :: InvoiceLastFinalizationError'Type' -> String

showList :: [InvoiceLastFinalizationError'Type'] -> ShowS

ToJSON InvoiceLastFinalizationError'Type'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLastFinalizationError'Type' -> Value

toEncoding :: InvoiceLastFinalizationError'Type' -> Encoding

toJSONList :: [InvoiceLastFinalizationError'Type'] -> Value

toEncodingList :: [InvoiceLastFinalizationError'Type'] -> Encoding

FromJSON InvoiceLastFinalizationError'Type'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLastFinalizationError'Type'

parseJSONList :: Value -> Parser [InvoiceLastFinalizationError'Type']

data InvoiceLines'

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.

Constructors

InvoiceLines'

Fields

• invoiceLines'Data :: [LineItem]

  data: Details about each object.

• invoiceLines'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• invoiceLines'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq InvoiceLines'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceLines'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceLines' -> ShowS

show :: InvoiceLines' -> String

showList :: [InvoiceLines'] -> ShowS

ToJSON InvoiceLines'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceLines' -> Value

toEncoding :: InvoiceLines' -> Encoding

toJSONList :: [InvoiceLines'] -> Value

toEncodingList :: [InvoiceLines'] -> Encoding

FromJSON InvoiceLines'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceLines'

parseJSONList :: Value -> Parser [InvoiceLines']

mkInvoiceLines'

Arguments

:: [LineItem]

invoiceLines'Data

-> Bool

invoiceLines'HasMore

-> Text

invoiceLines'Url

-> InvoiceLines'

Create a new InvoiceLines' with all required fields.

data InvoiceOnBehalfOf'Variants

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.

Constructors

InvoiceOnBehalfOf'Text Text

InvoiceOnBehalfOf'Account Account

Instances

Eq InvoiceOnBehalfOf'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceOnBehalfOf'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoiceOnBehalfOf'Variants -> String

showList :: [InvoiceOnBehalfOf'Variants] -> ShowS

ToJSON InvoiceOnBehalfOf'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceOnBehalfOf'Variants -> Value

toEncoding :: InvoiceOnBehalfOf'Variants -> Encoding

toJSONList :: [InvoiceOnBehalfOf'Variants] -> Value

toEncodingList :: [InvoiceOnBehalfOf'Variants] -> Encoding

FromJSON InvoiceOnBehalfOf'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceOnBehalfOf'Variants

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

data InvoicePaymentIntent'Variants

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.

Constructors

InvoicePaymentIntent'Text Text

InvoicePaymentIntent'PaymentIntent PaymentIntent

Instances

Eq InvoicePaymentIntent'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoicePaymentIntent'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoicePaymentIntent'Variants -> String

showList :: [InvoicePaymentIntent'Variants] -> ShowS

ToJSON InvoicePaymentIntent'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoicePaymentIntent'Variants -> Value

toEncoding :: InvoicePaymentIntent'Variants -> Encoding

toJSONList :: [InvoicePaymentIntent'Variants] -> Value

toEncodingList :: [InvoicePaymentIntent'Variants] -> Encoding

FromJSON InvoicePaymentIntent'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoicePaymentIntent'Variants

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

data InvoiceStatus'

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

Constructors

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 "deleted"

InvoiceStatus'EnumDraft

Represents the JSON value "draft"

InvoiceStatus'EnumOpen

Represents the JSON value "open"

InvoiceStatus'EnumPaid

Represents the JSON value "paid"

InvoiceStatus'EnumUncollectible

Represents the JSON value "uncollectible"

InvoiceStatus'EnumVoid

Represents the JSON value "void"

Instances

Eq InvoiceStatus'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceStatus'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceStatus' -> ShowS

show :: InvoiceStatus' -> String

showList :: [InvoiceStatus'] -> ShowS

ToJSON InvoiceStatus'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceStatus' -> Value

toEncoding :: InvoiceStatus' -> Encoding

toJSONList :: [InvoiceStatus'] -> Value

toEncodingList :: [InvoiceStatus'] -> Encoding

FromJSON InvoiceStatus'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceStatus'

parseJSONList :: Value -> Parser [InvoiceStatus']

data InvoiceSubscription'Variants

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.

Constructors

InvoiceSubscription'Text Text

InvoiceSubscription'Subscription Subscription

Instances

Eq InvoiceSubscription'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceSubscription'Variants

Defined in StripeAPI.Types.Invoice

Methods

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

show :: InvoiceSubscription'Variants -> String

showList :: [InvoiceSubscription'Variants] -> ShowS

ToJSON InvoiceSubscription'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceSubscription'Variants -> Value

toEncoding :: InvoiceSubscription'Variants -> Encoding

toJSONList :: [InvoiceSubscription'Variants] -> Value

toEncodingList :: [InvoiceSubscription'Variants] -> Encoding

FromJSON InvoiceSubscription'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceSubscription'Variants

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

data InvoiceTransferData'

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.

Constructors

InvoiceTransferData'

Fields

• invoiceTransferData'Amount :: Maybe Int

  amount: The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.

• invoiceTransferData'Destination :: Maybe InvoiceTransferData'Destination'Variants

  destination: The account where funds from the payment will be transferred to upon payment success.

Instances

Eq InvoiceTransferData'

Defined in StripeAPI.Types.Invoice

Methods

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

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

Show InvoiceTransferData'

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceTransferData' -> ShowS

show :: InvoiceTransferData' -> String

showList :: [InvoiceTransferData'] -> ShowS

ToJSON InvoiceTransferData'

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceTransferData' -> Value

toEncoding :: InvoiceTransferData' -> Encoding

toJSONList :: [InvoiceTransferData'] -> Value

toEncodingList :: [InvoiceTransferData'] -> Encoding

FromJSON InvoiceTransferData'

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceTransferData'

parseJSONList :: Value -> Parser [InvoiceTransferData']

mkInvoiceTransferData' :: InvoiceTransferData'

Create a new InvoiceTransferData' with all required fields.

data InvoiceTransferData'Destination'Variants

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.

Constructors

InvoiceTransferData'Destination'Text Text

InvoiceTransferData'Destination'Account Account

Instances

Eq InvoiceTransferData'Destination'Variants

Defined in StripeAPI.Types.Invoice

Methods

(==) :: InvoiceTransferData'Destination'Variants -> InvoiceTransferData'Destination'Variants -> Bool

(/=) :: InvoiceTransferData'Destination'Variants -> InvoiceTransferData'Destination'Variants -> Bool

Show InvoiceTransferData'Destination'Variants

Defined in StripeAPI.Types.Invoice

Methods

showsPrec :: Int -> InvoiceTransferData'Destination'Variants -> ShowS

show :: InvoiceTransferData'Destination'Variants -> String

showList :: [InvoiceTransferData'Destination'Variants] -> ShowS

ToJSON InvoiceTransferData'Destination'Variants

Defined in StripeAPI.Types.Invoice

Methods

toJSON :: InvoiceTransferData'Destination'Variants -> Value

toEncoding :: InvoiceTransferData'Destination'Variants -> Encoding

toJSONList :: [InvoiceTransferData'Destination'Variants] -> Value

toEncodingList :: [InvoiceTransferData'Destination'Variants] -> Encoding

FromJSON InvoiceTransferData'Destination'Variants

Defined in StripeAPI.Types.Invoice

Methods

parseJSON :: Value -> Parser InvoiceTransferData'Destination'Variants

parseJSONList :: Value -> Parser [InvoiceTransferData'Destination'Variants]