stripeapi-2.0.0.1: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.Customer

Description

Contains the types generated from the schema Customer

Synopsis

Documentation

data Customer Source #

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

Instances

Instances details
Eq Customer Source # 
Instance details

Defined in StripeAPI.Types.Customer

Show Customer Source # 
Instance details

Defined in StripeAPI.Types.Customer

ToJSON Customer Source # 
Instance details

Defined in StripeAPI.Types.Customer

FromJSON Customer Source # 
Instance details

Defined in StripeAPI.Types.Customer

mkCustomer Source #

Create a new Customer with all required fields.

data CustomerAddress' Source #

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

The customer\'s address.

Constructors

CustomerAddress' 

Fields

mkCustomerAddress' :: CustomerAddress' Source #

Create a new CustomerAddress' with all required fields.

data CustomerDefaultSource'Variants Source #

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.

data CustomerDiscount' Source #

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

mkCustomerDiscount' :: CustomerDiscount' Source #

Create a new CustomerDiscount' with all required fields.

data CustomerDiscount'Customer'Variants Source #

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.

data CustomerDiscount'Object' Source #

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"

data CustomerDiscount'PromotionCode'Variants Source #

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.

data CustomerShipping' Source #

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

mkCustomerShipping' :: CustomerShipping' Source #

Create a new CustomerShipping' with all required fields.

data CustomerSources' Source #

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

The customer's payment sources, if any.

Constructors

CustomerSources' 

Fields

data CustomerSources'Data' Source #

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

Constructors

CustomerSources'Data' 

Fields

data CustomerSources'Data'Account'Variants Source #

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.

data CustomerSources'Data'AvailablePayoutMethods' Source #

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"

data CustomerSources'Data'Customer'Variants Source #

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.

data CustomerSources'Data'Object' Source #

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"

data CustomerSources'Data'Owner' Source #

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

data CustomerSources'Data'Owner'Address' Source #

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

data CustomerSources'Data'Owner'VerifiedAddress' Source #

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

data CustomerSources'Data'Recipient'Variants Source #

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.

data CustomerSources'Data'Transactions' Source #

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

data CustomerSources'Data'Type' Source #

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"

data CustomerSubscriptions' Source #

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

The customer's current subscriptions, if any.

Constructors

CustomerSubscriptions' 

Fields

data CustomerTaxExempt' Source #

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"

data CustomerTaxIds' Source #

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

The customer's tax IDs.

Constructors

CustomerTaxIds' 

Fields