StripeAPI.Types.Customer

Contains the types generated from the schema Customer

Documentation

data Customer

Defines the object schema located at components.schemas.customer in the specification.

`Customer` objects allow you to perform recurring charges, and to track multiple charges, that are associated with the same customer. The API allows you to create, delete, and update your customers. You can retrieve individual customers as well as a list of all your customers.

Related guide: Save a card during payment.

Constructors

Customer

Fields

• customerAddress :: Maybe CustomerAddress'

  address: The customer's address.

• customerBalance :: Maybe Int

  balance: Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.

• customerCreated :: Int

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

• customerCurrency :: Maybe Text

  currency: Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

  Constraints:

  • Maximum length of 5000
• customerDefaultSource :: Maybe CustomerDefaultSource'Variants

  default_source: ID of the default payment source for the customer.

  If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

• customerDelinquent :: Maybe Bool

  delinquent: When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date.

  If an invoice is marked uncollectible by dunning, `delinquent` doesn't get reset to `false`.

• customerDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• customerDiscount :: Maybe CustomerDiscount'

  discount: Describes the current discount active on the customer, if there is one.

• customerEmail :: Maybe Text

  email: The customer's email address.

  Constraints:

  • Maximum length of 5000
• customerId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• customerInvoicePrefix :: Maybe Text

  invoice_prefix: The prefix for the customer used to generate unique invoice numbers.

  Constraints:

  • Maximum length of 5000
• customerInvoiceSettings :: Maybe InvoiceSettingCustomerSetting

  invoice_settings:

• customerLivemode :: Bool

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

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

• customerName :: Maybe Text

  name: The customer's full name or business name.

  Constraints:

  • Maximum length of 5000
• customerNextInvoiceSequence :: Maybe Int

  next_invoice_sequence: The suffix of the customer's next invoice number, e.g., 0001.

• customerPhone :: Maybe Text

  phone: The customer's phone number.

  Constraints:

  • Maximum length of 5000
• customerPreferredLocales :: Maybe [Text]

  preferred_locales: The customer's preferred locales (languages), ordered by preference.

• customerShipping :: Maybe CustomerShipping'

  shipping: Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

• customerSources :: Maybe CustomerSources'

  sources: The customer's payment sources, if any.

• customerSubscriptions :: Maybe CustomerSubscriptions'

  subscriptions: The customer's current subscriptions, if any.

• customerTax :: Maybe CustomerTax

  tax:

• customerTaxExempt :: Maybe CustomerTaxExempt'

  tax_exempt: Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**.

• customerTaxIds :: Maybe CustomerTaxIds'

  tax_ids: The customer's tax IDs.

Instances

Eq Customer

Defined in StripeAPI.Types.Customer

Methods

(==) :: Customer -> Customer -> Bool

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

Show Customer

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> Customer -> ShowS

show :: Customer -> String

showList :: [Customer] -> ShowS

ToJSON Customer

Defined in StripeAPI.Types.Customer

Methods

toJSON :: Customer -> Value

toEncoding :: Customer -> Encoding

toJSONList :: [Customer] -> Value

toEncodingList :: [Customer] -> Encoding

FromJSON Customer

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser Customer

parseJSONList :: Value -> Parser [Customer]

mkCustomer

Arguments

:: Int

customerCreated

-> Text

customerId

-> Bool

customerLivemode

-> Customer

Create a new Customer with all required fields.

data CustomerAddress'

Defines the object schema located at components.schemas.customer.properties.address.anyOf in the specification.

The customer\'s address.

Constructors

CustomerAddress'

Fields

• customerAddress'City :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerAddress'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
• customerAddress'Line1 :: Maybe Text

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

  Constraints:

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

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

  Constraints:

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

  postal_code: ZIP or postal code.

  Constraints:

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

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq CustomerAddress'

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerAddress'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerAddress' -> ShowS

show :: CustomerAddress' -> String

showList :: [CustomerAddress'] -> ShowS

ToJSON CustomerAddress'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerAddress' -> Value

toEncoding :: CustomerAddress' -> Encoding

toJSONList :: [CustomerAddress'] -> Value

toEncodingList :: [CustomerAddress'] -> Encoding

FromJSON CustomerAddress'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerAddress'

parseJSONList :: Value -> Parser [CustomerAddress']

mkCustomerAddress' :: CustomerAddress'

Create a new CustomerAddress' with all required fields.

data CustomerDefaultSource'Variants

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

ID of the default payment source for the customer.

If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

Constructors

CustomerDefaultSource'Text Text

CustomerDefaultSource'AlipayAccount AlipayAccount

CustomerDefaultSource'BankAccount BankAccount

CustomerDefaultSource'BitcoinReceiver BitcoinReceiver

CustomerDefaultSource'Card Card

CustomerDefaultSource'Source Source

Instances

Eq CustomerDefaultSource'Variants

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerDefaultSource'Variants

Defined in StripeAPI.Types.Customer

Methods

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

show :: CustomerDefaultSource'Variants -> String

showList :: [CustomerDefaultSource'Variants] -> ShowS

ToJSON CustomerDefaultSource'Variants

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerDefaultSource'Variants -> Value

toEncoding :: CustomerDefaultSource'Variants -> Encoding

toJSONList :: [CustomerDefaultSource'Variants] -> Value

toEncodingList :: [CustomerDefaultSource'Variants] -> Encoding

FromJSON CustomerDefaultSource'Variants

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerDefaultSource'Variants

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

data CustomerDiscount'

Defines the object schema located at components.schemas.customer.properties.discount.anyOf in the specification.

Describes the current discount active on the customer, if there is one.

Constructors

CustomerDiscount'

Fields

• customerDiscount'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
• customerDiscount'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.

• customerDiscount'Customer :: Maybe CustomerDiscount'Customer'Variants

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

• customerDiscount'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.

• customerDiscount'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
• customerDiscount'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
• customerDiscount'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
• customerDiscount'Object :: Maybe CustomerDiscount'Object'

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

• customerDiscount'PromotionCode :: Maybe CustomerDiscount'PromotionCode'Variants

  promotion_code: The promotion code applied to create this discount.

• customerDiscount'Start :: Maybe Int

  start: Date that the coupon was applied.

• customerDiscount'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 CustomerDiscount'

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerDiscount'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerDiscount' -> ShowS

show :: CustomerDiscount' -> String

showList :: [CustomerDiscount'] -> ShowS

ToJSON CustomerDiscount'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerDiscount' -> Value

toEncoding :: CustomerDiscount' -> Encoding

toJSONList :: [CustomerDiscount'] -> Value

toEncodingList :: [CustomerDiscount'] -> Encoding

FromJSON CustomerDiscount'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerDiscount'

parseJSONList :: Value -> Parser [CustomerDiscount']

mkCustomerDiscount' :: CustomerDiscount'

Create a new CustomerDiscount' with all required fields.

data CustomerDiscount'Customer'Variants

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

The ID of the customer associated with this discount.

Constructors

CustomerDiscount'Customer'Text Text

CustomerDiscount'Customer'Customer Customer

CustomerDiscount'Customer'DeletedCustomer DeletedCustomer

Instances

Eq CustomerDiscount'Customer'Variants

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerDiscount'Customer'Variants

Defined in StripeAPI.Types.Customer

Methods

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

show :: CustomerDiscount'Customer'Variants -> String

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

ToJSON CustomerDiscount'Customer'Variants

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerDiscount'Customer'Variants -> Value

toEncoding :: CustomerDiscount'Customer'Variants -> Encoding

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

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

FromJSON CustomerDiscount'Customer'Variants

Defined in StripeAPI.Types.Customer

Methods

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

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

data CustomerDiscount'Object'

Defines the enum schema located at components.schemas.customer.properties.discount.anyOf.properties.object in the specification.

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

Constructors

CustomerDiscount'Object'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

CustomerDiscount'Object'Typed Text

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

CustomerDiscount'Object'EnumDiscount

Represents the JSON value "discount"

Instances

Eq CustomerDiscount'Object'

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerDiscount'Object'

Defined in StripeAPI.Types.Customer

Methods

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

show :: CustomerDiscount'Object' -> String

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

ToJSON CustomerDiscount'Object'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerDiscount'Object' -> Value

toEncoding :: CustomerDiscount'Object' -> Encoding

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

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

FromJSON CustomerDiscount'Object'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerDiscount'Object'

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

data CustomerDiscount'PromotionCode'Variants

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

The promotion code applied to create this discount.

Constructors

CustomerDiscount'PromotionCode'Text Text

CustomerDiscount'PromotionCode'PromotionCode PromotionCode

Instances

Eq CustomerDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Customer

Methods

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

show :: CustomerDiscount'PromotionCode'Variants -> String

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

ToJSON CustomerDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerDiscount'PromotionCode'Variants -> Value

toEncoding :: CustomerDiscount'PromotionCode'Variants -> Encoding

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

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

FromJSON CustomerDiscount'PromotionCode'Variants

Defined in StripeAPI.Types.Customer

Methods

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

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

data CustomerShipping'

Defines the object schema located at components.schemas.customer.properties.shipping.anyOf in the specification.

Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

Constructors

CustomerShipping'

Fields

• customerShipping'Address :: Maybe Address

  address:

• customerShipping'Carrier :: Maybe Text

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

  Constraints:

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

  name: Recipient name.

  Constraints:

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

  phone: Recipient phone (including extension).

  Constraints:

  • Maximum length of 5000
• customerShipping'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 CustomerShipping'

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerShipping'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerShipping' -> ShowS

show :: CustomerShipping' -> String

showList :: [CustomerShipping'] -> ShowS

ToJSON CustomerShipping'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerShipping' -> Value

toEncoding :: CustomerShipping' -> Encoding

toJSONList :: [CustomerShipping'] -> Value

toEncodingList :: [CustomerShipping'] -> Encoding

FromJSON CustomerShipping'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerShipping'

parseJSONList :: Value -> Parser [CustomerShipping']

mkCustomerShipping' :: CustomerShipping'

Create a new CustomerShipping' with all required fields.

data CustomerSources'

Defines the object schema located at components.schemas.customer.properties.sources in the specification.

The customer's payment sources, if any.

Constructors

CustomerSources'

Fields

• customerSources'Data :: [CustomerSources'Data']

  data: Details about each object.

• customerSources'HasMore :: Bool

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

• customerSources'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq CustomerSources'

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerSources'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources' -> ShowS

show :: CustomerSources' -> String

showList :: [CustomerSources'] -> ShowS

ToJSON CustomerSources'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources' -> Value

toEncoding :: CustomerSources' -> Encoding

toJSONList :: [CustomerSources'] -> Value

toEncodingList :: [CustomerSources'] -> Encoding

FromJSON CustomerSources'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'

parseJSONList :: Value -> Parser [CustomerSources']

mkCustomerSources'

Arguments

:: [CustomerSources'Data']

customerSources'Data

-> Bool

customerSources'HasMore

-> Text

customerSources'Url

-> CustomerSources'

Create a new CustomerSources' with all required fields.

data CustomerSources'Data'

Defines the object schema located at components.schemas.customer.properties.sources.properties.data.items.anyOf in the specification.

Constructors

CustomerSources'Data'

Fields

• customerSources'Data'Account :: Maybe CustomerSources'Data'Account'Variants

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

• customerSources'Data'AccountHolderName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'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
• customerSources'Data'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer

  ach_credit_transfer

• customerSources'Data'AchDebit :: Maybe SourceTypeAchDebit

  ach_debit

• customerSources'Data'AcssDebit :: Maybe SourceTypeAcssDebit

  acss_debit

• customerSources'Data'Active :: Maybe Bool

  active: True when this bitcoin receiver has received a non-zero amount of bitcoin.

• customerSources'Data'AddressCity :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'AddressCountry :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'AddressLine1 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'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
• customerSources'Data'AddressLine2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'AddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'AddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'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
• customerSources'Data'Alipay :: Maybe SourceTypeAlipay

  alipay

• customerSources'Data'Amount :: Maybe Int

  amount: The amount of `currency` that you are collecting as payment.

• customerSources'Data'AmountReceived :: Maybe Int

  amount_received: The amount of `currency` to which `bitcoin_amount_received` has been converted.

• customerSources'Data'AuBecsDebit :: Maybe SourceTypeAuBecsDebit

  au_becs_debit

• customerSources'Data'AvailablePayoutMethods :: Maybe [CustomerSources'Data'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.

• customerSources'Data'Bancontact :: Maybe SourceTypeBancontact

  bancontact

• customerSources'Data'BankName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'BitcoinAmount :: Maybe Int

  bitcoin_amount: The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

• customerSources'Data'BitcoinAmountReceived :: Maybe Int

  bitcoin_amount_received: The amount of bitcoin that has been sent by the customer to this receiver.

• customerSources'Data'BitcoinUri :: Maybe Text

  bitcoin_uri: This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets).

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Brand :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Card :: Maybe SourceTypeCard

  card

• customerSources'Data'CardPresent :: Maybe SourceTypeCardPresent

  card_present

• customerSources'Data'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
• customerSources'Data'CodeVerification :: Maybe SourceCodeVerificationFlow

  code_verification:

• customerSources'Data'Country :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Created :: Maybe Int

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

• customerSources'Data'Currency :: Maybe Text

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

• customerSources'Data'Customer :: Maybe CustomerSources'Data'Customer'Variants

  customer: The ID of the customer associated with this Alipay Account.

• customerSources'Data'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
• customerSources'Data'DefaultForCurrency :: Maybe Bool

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

• customerSources'Data'Description :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'DynamicLast4 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Email :: Maybe Text

  email: The customer's email address, set by the API call that creates the receiver.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Eps :: Maybe SourceTypeEps

  eps

• customerSources'Data'ExpMonth :: Maybe Int

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

• customerSources'Data'ExpYear :: Maybe Int

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

• customerSources'Data'Filled :: Maybe Bool

  filled: This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver.

• customerSources'Data'Fingerprint :: Maybe Text

  fingerprint: Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Flow :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Funding :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Giropay :: Maybe SourceTypeGiropay

  giropay

• customerSources'Data'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Ideal :: Maybe SourceTypeIdeal

  ideal

• customerSources'Data'InboundAddress :: Maybe Text

  inbound_address: A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Klarna :: Maybe SourceTypeKlarna

  klarna

• customerSources'Data'Last4 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'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.

• customerSources'Data'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.

• customerSources'Data'Multibanco :: Maybe SourceTypeMultibanco

  multibanco

• customerSources'Data'Name :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Object :: Maybe CustomerSources'Data'Object'

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

• customerSources'Data'Owner :: Maybe CustomerSources'Data'Owner'

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

• customerSources'Data'P24 :: Maybe SourceTypeP24

  p24

• customerSources'Data'Payment :: Maybe Text

  payment: The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'PaymentAmount :: Maybe Int

  payment_amount: If the Alipay account object is not reusable, the exact amount that you can create a charge for.

• customerSources'Data'PaymentCurrency :: Maybe Text

  payment_currency: If the Alipay account object is not reusable, the exact currency that you can create a charge for.

• customerSources'Data'Receiver :: Maybe SourceReceiverFlow

  receiver:

• customerSources'Data'Recipient :: Maybe CustomerSources'Data'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.

• customerSources'Data'Redirect :: Maybe SourceRedirectFlow

  redirect:

• customerSources'Data'RefundAddress :: Maybe Text

  refund_address: The refund address of this bitcoin receiver.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Reusable :: Maybe Bool

  reusable: True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment.

• customerSources'Data'RoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'SepaDebit :: Maybe SourceTypeSepaDebit

  sepa_debit

• customerSources'Data'Sofort :: Maybe SourceTypeSofort

  sofort

• customerSources'Data'SourceOrder :: Maybe SourceOrder

  source_order:

• customerSources'Data'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
• customerSources'Data'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
• customerSources'Data'ThreeDSecure :: Maybe SourceTypeThreeDSecure

  three_d_secure

• customerSources'Data'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
• customerSources'Data'Transactions :: Maybe CustomerSources'Data'Transactions'

  transactions: A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key.

• customerSources'Data'Type :: Maybe CustomerSources'Data'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.

• customerSources'Data'UncapturedFunds :: Maybe Bool

  uncaptured_funds: This receiver contains uncaptured funds that can be used for a payment or refunded.

• customerSources'Data'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
• customerSources'Data'Used :: Maybe Bool

  used: Whether this Alipay account object has ever been used for a payment.

• customerSources'Data'UsedForPayment :: Maybe Bool

  used_for_payment: Indicate if this source is used for payment.

• customerSources'Data'Username :: Maybe Text

  username: The username for the Alipay account.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Wechat :: Maybe SourceTypeWechat

  wechat

Instances

Eq CustomerSources'Data'

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data' -> CustomerSources'Data' -> Bool

(/=) :: CustomerSources'Data' -> CustomerSources'Data' -> Bool

Show CustomerSources'Data'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data' -> ShowS

show :: CustomerSources'Data' -> String

showList :: [CustomerSources'Data'] -> ShowS

ToJSON CustomerSources'Data'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data' -> Value

toEncoding :: CustomerSources'Data' -> Encoding

toJSONList :: [CustomerSources'Data'] -> Value

toEncodingList :: [CustomerSources'Data'] -> Encoding

FromJSON CustomerSources'Data'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'

parseJSONList :: Value -> Parser [CustomerSources'Data']

mkCustomerSources'Data' :: CustomerSources'Data'

Create a new CustomerSources'Data' with all required fields.

data CustomerSources'Data'Account'Variants

Defines the oneOf schema located at components.schemas.customer.properties.sources.properties.data.items.anyOf.properties.account.anyOf in the specification.

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

Constructors

CustomerSources'Data'Account'Text Text

CustomerSources'Data'Account'Account Account

Instances

Eq CustomerSources'Data'Account'Variants

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Account'Variants -> CustomerSources'Data'Account'Variants -> Bool

(/=) :: CustomerSources'Data'Account'Variants -> CustomerSources'Data'Account'Variants -> Bool

Show CustomerSources'Data'Account'Variants

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Account'Variants -> ShowS

show :: CustomerSources'Data'Account'Variants -> String

showList :: [CustomerSources'Data'Account'Variants] -> ShowS

ToJSON CustomerSources'Data'Account'Variants

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Account'Variants -> Value

toEncoding :: CustomerSources'Data'Account'Variants -> Encoding

toJSONList :: [CustomerSources'Data'Account'Variants] -> Value

toEncodingList :: [CustomerSources'Data'Account'Variants] -> Encoding

FromJSON CustomerSources'Data'Account'Variants

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Account'Variants

parseJSONList :: Value -> Parser [CustomerSources'Data'Account'Variants]

data CustomerSources'Data'AvailablePayoutMethods'

Defines the enum schema located at components.schemas.customer.properties.sources.properties.data.items.anyOf.properties.available_payout_methods.items in the specification.

Constructors

CustomerSources'Data'AvailablePayoutMethods'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

CustomerSources'Data'AvailablePayoutMethods'Typed Text

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

CustomerSources'Data'AvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

CustomerSources'Data'AvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq CustomerSources'Data'AvailablePayoutMethods'

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'AvailablePayoutMethods' -> CustomerSources'Data'AvailablePayoutMethods' -> Bool

(/=) :: CustomerSources'Data'AvailablePayoutMethods' -> CustomerSources'Data'AvailablePayoutMethods' -> Bool

Show CustomerSources'Data'AvailablePayoutMethods'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'AvailablePayoutMethods' -> ShowS

show :: CustomerSources'Data'AvailablePayoutMethods' -> String

showList :: [CustomerSources'Data'AvailablePayoutMethods'] -> ShowS

ToJSON CustomerSources'Data'AvailablePayoutMethods'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'AvailablePayoutMethods' -> Value

toEncoding :: CustomerSources'Data'AvailablePayoutMethods' -> Encoding

toJSONList :: [CustomerSources'Data'AvailablePayoutMethods'] -> Value

toEncodingList :: [CustomerSources'Data'AvailablePayoutMethods'] -> Encoding

FromJSON CustomerSources'Data'AvailablePayoutMethods'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'AvailablePayoutMethods'

parseJSONList :: Value -> Parser [CustomerSources'Data'AvailablePayoutMethods']

data CustomerSources'Data'Customer'Variants

Defines the oneOf schema located at components.schemas.customer.properties.sources.properties.data.items.anyOf.properties.customer.anyOf in the specification.

The ID of the customer associated with this Alipay Account.

Constructors

CustomerSources'Data'Customer'Text Text

CustomerSources'Data'Customer'Customer Customer

CustomerSources'Data'Customer'DeletedCustomer DeletedCustomer

Instances

Eq CustomerSources'Data'Customer'Variants

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Customer'Variants -> CustomerSources'Data'Customer'Variants -> Bool

(/=) :: CustomerSources'Data'Customer'Variants -> CustomerSources'Data'Customer'Variants -> Bool

Show CustomerSources'Data'Customer'Variants

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Customer'Variants -> ShowS

show :: CustomerSources'Data'Customer'Variants -> String

showList :: [CustomerSources'Data'Customer'Variants] -> ShowS

ToJSON CustomerSources'Data'Customer'Variants

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Customer'Variants -> Value

toEncoding :: CustomerSources'Data'Customer'Variants -> Encoding

toJSONList :: [CustomerSources'Data'Customer'Variants] -> Value

toEncodingList :: [CustomerSources'Data'Customer'Variants] -> Encoding

FromJSON CustomerSources'Data'Customer'Variants

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Customer'Variants

parseJSONList :: Value -> Parser [CustomerSources'Data'Customer'Variants]

data CustomerSources'Data'Object'

Defines the enum schema located at components.schemas.customer.properties.sources.properties.data.items.anyOf.properties.object in the specification.

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

Constructors

CustomerSources'Data'Object'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

CustomerSources'Data'Object'Typed Text

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

CustomerSources'Data'Object'EnumAlipayAccount

Represents the JSON value "alipay_account"

Instances

Eq CustomerSources'Data'Object'

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Object' -> CustomerSources'Data'Object' -> Bool

(/=) :: CustomerSources'Data'Object' -> CustomerSources'Data'Object' -> Bool

Show CustomerSources'Data'Object'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Object' -> ShowS

show :: CustomerSources'Data'Object' -> String

showList :: [CustomerSources'Data'Object'] -> ShowS

ToJSON CustomerSources'Data'Object'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Object' -> Value

toEncoding :: CustomerSources'Data'Object' -> Encoding

toJSONList :: [CustomerSources'Data'Object'] -> Value

toEncodingList :: [CustomerSources'Data'Object'] -> Encoding

FromJSON CustomerSources'Data'Object'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Object'

parseJSONList :: Value -> Parser [CustomerSources'Data'Object']

data CustomerSources'Data'Owner'

Defines the object schema located at components.schemas.customer.properties.sources.properties.data.items.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

CustomerSources'Data'Owner'

Fields

• customerSources'Data'Owner'Address :: Maybe CustomerSources'Data'Owner'Address'

  address: Owner's address.

• customerSources'Data'Owner'Email :: Maybe Text

  email: Owner's email address.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'Name :: Maybe Text

  name: Owner's full name.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'Phone :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'VerifiedAddress :: Maybe CustomerSources'Data'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.

• customerSources'Data'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
• customerSources'Data'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
• customerSources'Data'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 CustomerSources'Data'Owner'

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Owner' -> CustomerSources'Data'Owner' -> Bool

(/=) :: CustomerSources'Data'Owner' -> CustomerSources'Data'Owner' -> Bool

Show CustomerSources'Data'Owner'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Owner' -> ShowS

show :: CustomerSources'Data'Owner' -> String

showList :: [CustomerSources'Data'Owner'] -> ShowS

ToJSON CustomerSources'Data'Owner'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Owner' -> Value

toEncoding :: CustomerSources'Data'Owner' -> Encoding

toJSONList :: [CustomerSources'Data'Owner'] -> Value

toEncodingList :: [CustomerSources'Data'Owner'] -> Encoding

FromJSON CustomerSources'Data'Owner'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Owner'

parseJSONList :: Value -> Parser [CustomerSources'Data'Owner']

mkCustomerSources'Data'Owner' :: CustomerSources'Data'Owner'

Create a new CustomerSources'Data'Owner' with all required fields.

data CustomerSources'Data'Owner'Address'

Defines the object schema located at components.schemas.customer.properties.sources.properties.data.items.anyOf.properties.owner.anyOf.properties.address.anyOf in the specification.

Owner\'s address.

Constructors

CustomerSources'Data'Owner'Address'

Fields

• customerSources'Data'Owner'Address'City :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'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
• customerSources'Data'Owner'Address'Line1 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'Address'Line2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'Address'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'Address'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq CustomerSources'Data'Owner'Address'

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Owner'Address' -> CustomerSources'Data'Owner'Address' -> Bool

(/=) :: CustomerSources'Data'Owner'Address' -> CustomerSources'Data'Owner'Address' -> Bool

Show CustomerSources'Data'Owner'Address'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Owner'Address' -> ShowS

show :: CustomerSources'Data'Owner'Address' -> String

showList :: [CustomerSources'Data'Owner'Address'] -> ShowS

ToJSON CustomerSources'Data'Owner'Address'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Owner'Address' -> Value

toEncoding :: CustomerSources'Data'Owner'Address' -> Encoding

toJSONList :: [CustomerSources'Data'Owner'Address'] -> Value

toEncodingList :: [CustomerSources'Data'Owner'Address'] -> Encoding

FromJSON CustomerSources'Data'Owner'Address'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Owner'Address'

parseJSONList :: Value -> Parser [CustomerSources'Data'Owner'Address']

mkCustomerSources'Data'Owner'Address' :: CustomerSources'Data'Owner'Address'

Create a new CustomerSources'Data'Owner'Address' with all required fields.

data CustomerSources'Data'Owner'VerifiedAddress'

Defines the object schema located at components.schemas.customer.properties.sources.properties.data.items.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

CustomerSources'Data'Owner'VerifiedAddress'

Fields

• customerSources'Data'Owner'VerifiedAddress'City :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'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
• customerSources'Data'Owner'VerifiedAddress'Line1 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'VerifiedAddress'Line2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'VerifiedAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• customerSources'Data'Owner'VerifiedAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq CustomerSources'Data'Owner'VerifiedAddress'

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Owner'VerifiedAddress' -> CustomerSources'Data'Owner'VerifiedAddress' -> Bool

(/=) :: CustomerSources'Data'Owner'VerifiedAddress' -> CustomerSources'Data'Owner'VerifiedAddress' -> Bool

Show CustomerSources'Data'Owner'VerifiedAddress'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Owner'VerifiedAddress' -> ShowS

show :: CustomerSources'Data'Owner'VerifiedAddress' -> String

showList :: [CustomerSources'Data'Owner'VerifiedAddress'] -> ShowS

ToJSON CustomerSources'Data'Owner'VerifiedAddress'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Owner'VerifiedAddress' -> Value

toEncoding :: CustomerSources'Data'Owner'VerifiedAddress' -> Encoding

toJSONList :: [CustomerSources'Data'Owner'VerifiedAddress'] -> Value

toEncodingList :: [CustomerSources'Data'Owner'VerifiedAddress'] -> Encoding

FromJSON CustomerSources'Data'Owner'VerifiedAddress'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Owner'VerifiedAddress'

parseJSONList :: Value -> Parser [CustomerSources'Data'Owner'VerifiedAddress']

mkCustomerSources'Data'Owner'VerifiedAddress' :: CustomerSources'Data'Owner'VerifiedAddress'

Create a new CustomerSources'Data'Owner'VerifiedAddress' with all required fields.

data CustomerSources'Data'Recipient'Variants

Defines the oneOf schema located at components.schemas.customer.properties.sources.properties.data.items.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

CustomerSources'Data'Recipient'Text Text

CustomerSources'Data'Recipient'Recipient Recipient

Instances

Eq CustomerSources'Data'Recipient'Variants

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Recipient'Variants -> CustomerSources'Data'Recipient'Variants -> Bool

(/=) :: CustomerSources'Data'Recipient'Variants -> CustomerSources'Data'Recipient'Variants -> Bool

Show CustomerSources'Data'Recipient'Variants

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Recipient'Variants -> ShowS

show :: CustomerSources'Data'Recipient'Variants -> String

showList :: [CustomerSources'Data'Recipient'Variants] -> ShowS

ToJSON CustomerSources'Data'Recipient'Variants

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Recipient'Variants -> Value

toEncoding :: CustomerSources'Data'Recipient'Variants -> Encoding

toJSONList :: [CustomerSources'Data'Recipient'Variants] -> Value

toEncodingList :: [CustomerSources'Data'Recipient'Variants] -> Encoding

FromJSON CustomerSources'Data'Recipient'Variants

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Recipient'Variants

parseJSONList :: Value -> Parser [CustomerSources'Data'Recipient'Variants]

data CustomerSources'Data'Transactions'

Defines the object schema located at components.schemas.customer.properties.sources.properties.data.items.anyOf.properties.transactions in the specification.

A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key.

Constructors

CustomerSources'Data'Transactions'

Fields

• customerSources'Data'Transactions'Data :: [BitcoinTransaction]

  data: Details about each object.

• customerSources'Data'Transactions'HasMore :: Bool

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

• customerSources'Data'Transactions'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq CustomerSources'Data'Transactions'

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Transactions' -> CustomerSources'Data'Transactions' -> Bool

(/=) :: CustomerSources'Data'Transactions' -> CustomerSources'Data'Transactions' -> Bool

Show CustomerSources'Data'Transactions'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Transactions' -> ShowS

show :: CustomerSources'Data'Transactions' -> String

showList :: [CustomerSources'Data'Transactions'] -> ShowS

ToJSON CustomerSources'Data'Transactions'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Transactions' -> Value

toEncoding :: CustomerSources'Data'Transactions' -> Encoding

toJSONList :: [CustomerSources'Data'Transactions'] -> Value

toEncodingList :: [CustomerSources'Data'Transactions'] -> Encoding

FromJSON CustomerSources'Data'Transactions'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Transactions'

parseJSONList :: Value -> Parser [CustomerSources'Data'Transactions']

mkCustomerSources'Data'Transactions'

Arguments

:: [BitcoinTransaction]

customerSources'Data'Transactions'Data

-> Bool

customerSources'Data'Transactions'HasMore

-> Text

customerSources'Data'Transactions'Url

-> CustomerSources'Data'Transactions'

Create a new CustomerSources'Data'Transactions' with all required fields.

data CustomerSources'Data'Type'

Defines the enum schema located at components.schemas.customer.properties.sources.properties.data.items.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

CustomerSources'Data'Type'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

CustomerSources'Data'Type'Typed Text

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

CustomerSources'Data'Type'EnumAchCreditTransfer

Represents the JSON value "ach_credit_transfer"

CustomerSources'Data'Type'EnumAchDebit

Represents the JSON value "ach_debit"

CustomerSources'Data'Type'EnumAcssDebit

Represents the JSON value "acss_debit"

CustomerSources'Data'Type'EnumAlipay

Represents the JSON value "alipay"

CustomerSources'Data'Type'EnumAuBecsDebit

Represents the JSON value "au_becs_debit"

CustomerSources'Data'Type'EnumBancontact

Represents the JSON value "bancontact"

CustomerSources'Data'Type'EnumCard

Represents the JSON value "card"

CustomerSources'Data'Type'EnumCardPresent

Represents the JSON value "card_present"

CustomerSources'Data'Type'EnumEps

Represents the JSON value "eps"

CustomerSources'Data'Type'EnumGiropay

Represents the JSON value "giropay"

CustomerSources'Data'Type'EnumIdeal

Represents the JSON value "ideal"

CustomerSources'Data'Type'EnumKlarna

Represents the JSON value "klarna"

CustomerSources'Data'Type'EnumMultibanco

Represents the JSON value "multibanco"

CustomerSources'Data'Type'EnumP24

Represents the JSON value "p24"

CustomerSources'Data'Type'EnumSepaDebit

Represents the JSON value "sepa_debit"

CustomerSources'Data'Type'EnumSofort

Represents the JSON value "sofort"

CustomerSources'Data'Type'EnumThreeDSecure

Represents the JSON value "three_d_secure"

CustomerSources'Data'Type'EnumWechat

Represents the JSON value "wechat"

Instances

Eq CustomerSources'Data'Type'

Defined in StripeAPI.Types.Customer

Methods

(==) :: CustomerSources'Data'Type' -> CustomerSources'Data'Type' -> Bool

(/=) :: CustomerSources'Data'Type' -> CustomerSources'Data'Type' -> Bool

Show CustomerSources'Data'Type'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSources'Data'Type' -> ShowS

show :: CustomerSources'Data'Type' -> String

showList :: [CustomerSources'Data'Type'] -> ShowS

ToJSON CustomerSources'Data'Type'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSources'Data'Type' -> Value

toEncoding :: CustomerSources'Data'Type' -> Encoding

toJSONList :: [CustomerSources'Data'Type'] -> Value

toEncodingList :: [CustomerSources'Data'Type'] -> Encoding

FromJSON CustomerSources'Data'Type'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSources'Data'Type'

parseJSONList :: Value -> Parser [CustomerSources'Data'Type']

data CustomerSubscriptions'

Defines the object schema located at components.schemas.customer.properties.subscriptions in the specification.

The customer's current subscriptions, if any.

Constructors

CustomerSubscriptions'

Fields

• customerSubscriptions'Data :: [Subscription]

  data: Details about each object.

• customerSubscriptions'HasMore :: Bool

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

• customerSubscriptions'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq CustomerSubscriptions'

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerSubscriptions'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerSubscriptions' -> ShowS

show :: CustomerSubscriptions' -> String

showList :: [CustomerSubscriptions'] -> ShowS

ToJSON CustomerSubscriptions'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerSubscriptions' -> Value

toEncoding :: CustomerSubscriptions' -> Encoding

toJSONList :: [CustomerSubscriptions'] -> Value

toEncodingList :: [CustomerSubscriptions'] -> Encoding

FromJSON CustomerSubscriptions'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerSubscriptions'

parseJSONList :: Value -> Parser [CustomerSubscriptions']

mkCustomerSubscriptions'

Arguments

:: [Subscription]

customerSubscriptions'Data

-> Bool

customerSubscriptions'HasMore

-> Text

customerSubscriptions'Url

-> CustomerSubscriptions'

Create a new CustomerSubscriptions' with all required fields.

data CustomerTaxExempt'

Defines the enum schema located at components.schemas.customer.properties.tax_exempt in the specification.

Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**.

Constructors

CustomerTaxExempt'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

CustomerTaxExempt'Typed Text

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

CustomerTaxExempt'EnumExempt

Represents the JSON value "exempt"

CustomerTaxExempt'EnumNone

Represents the JSON value "none"

CustomerTaxExempt'EnumReverse

Represents the JSON value "reverse"

Instances

Eq CustomerTaxExempt'

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerTaxExempt'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerTaxExempt' -> ShowS

show :: CustomerTaxExempt' -> String

showList :: [CustomerTaxExempt'] -> ShowS

ToJSON CustomerTaxExempt'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerTaxExempt' -> Value

toEncoding :: CustomerTaxExempt' -> Encoding

toJSONList :: [CustomerTaxExempt'] -> Value

toEncodingList :: [CustomerTaxExempt'] -> Encoding

FromJSON CustomerTaxExempt'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerTaxExempt'

parseJSONList :: Value -> Parser [CustomerTaxExempt']

data CustomerTaxIds'

Defines the object schema located at components.schemas.customer.properties.tax_ids in the specification.

The customer's tax IDs.

Constructors

CustomerTaxIds'

Fields

• customerTaxIds'Data :: [TaxId]

  data: Details about each object.

• customerTaxIds'HasMore :: Bool

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

• customerTaxIds'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq CustomerTaxIds'

Defined in StripeAPI.Types.Customer

Methods

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

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

Show CustomerTaxIds'

Defined in StripeAPI.Types.Customer

Methods

showsPrec :: Int -> CustomerTaxIds' -> ShowS

show :: CustomerTaxIds' -> String

showList :: [CustomerTaxIds'] -> ShowS

ToJSON CustomerTaxIds'

Defined in StripeAPI.Types.Customer

Methods

toJSON :: CustomerTaxIds' -> Value

toEncoding :: CustomerTaxIds' -> Encoding

toJSONList :: [CustomerTaxIds'] -> Value

toEncodingList :: [CustomerTaxIds'] -> Encoding

FromJSON CustomerTaxIds'

Defined in StripeAPI.Types.Customer

Methods

parseJSON :: Value -> Parser CustomerTaxIds'

parseJSONList :: Value -> Parser [CustomerTaxIds']

mkCustomerTaxIds'

Arguments

:: [TaxId]

customerTaxIds'Data

-> Bool

customerTaxIds'HasMore

-> Text

customerTaxIds'Url

-> CustomerTaxIds'

Create a new CustomerTaxIds' with all required fields.