Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.Mandate

Description

Contains the types generated from the schema Mandate

Synopsis

Documentation

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

A Mandate is a record of the permission a customer has given you to debit their payment method.

Constructors

Fields

mandateCustomerAcceptance :: CustomerAcceptance
customer_acceptance:
mandateId :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
mandateLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
mandateMultiUse :: Maybe MandateMultiUse
multi_use:
mandatePaymentMethod :: MandatePaymentMethod'Variants
payment_method: ID of the payment method associated with this mandate.
mandatePaymentMethodDetails :: MandatePaymentMethodDetails
payment_method_details:
mandateSingleUse :: Maybe MandateSingleUse
single_use:
mandateStatus :: MandateStatus'
status: The status of the mandate, which indicates whether it can be used to initiate a payment.
mandateType :: MandateType'
type: The type of the mandate.

Instances details

Eq Mandate Source #
Instance details Defined in StripeAPI.Types.Mandate Methods (==) :: Mandate -> Mandate -> Bool # (/=) :: Mandate -> Mandate -> Bool #
Show Mandate Source #
Instance details Defined in StripeAPI.Types.Mandate Methods showsPrec :: Int -> Mandate -> ShowS # show :: Mandate -> String # showList :: [Mandate] -> ShowS #
ToJSON Mandate Source #
Instance details Defined in StripeAPI.Types.Mandate Methods toJSON :: Mandate -> Value # toEncoding :: Mandate -> Encoding # toJSONList :: [Mandate] -> Value # toEncodingList :: [Mandate] -> Encoding #
FromJSON Mandate Source #
Instance details Defined in StripeAPI.Types.Mandate Methods parseJSON :: Value -> Parser Mandate # parseJSONList :: Value -> Parser [Mandate] #

Arguments

:: CustomerAcceptance	`mandateCustomerAcceptance`
-> Text	`mandateId`
-> Bool	`mandateLivemode`
-> MandatePaymentMethod'Variants	`mandatePaymentMethod`
-> MandatePaymentMethodDetails	`mandatePaymentMethodDetails`
-> MandateStatus'	`mandateStatus`
-> MandateType'	`mandateType`
-> Mandate

Create a new Mandate with all required fields.

Defines the oneOf schema located at components.schemas.mandate.properties.payment_method.anyOf in the specification.

ID of the payment method associated with this mandate.

Constructors

MandatePaymentMethod'Text Text
MandatePaymentMethod'PaymentMethod PaymentMethod

Instances details

Eq MandatePaymentMethod'Variants Source #
Instance details Defined in StripeAPI.Types.Mandate Methods (==) :: MandatePaymentMethod'Variants -> MandatePaymentMethod'Variants -> Bool # (/=) :: MandatePaymentMethod'Variants -> MandatePaymentMethod'Variants -> Bool #
Show MandatePaymentMethod'Variants Source #
Instance details Defined in StripeAPI.Types.Mandate Methods showsPrec :: Int -> MandatePaymentMethod'Variants -> ShowS # show :: MandatePaymentMethod'Variants -> String # showList :: [MandatePaymentMethod'Variants] -> ShowS #
ToJSON MandatePaymentMethod'Variants Source #
Instance details Defined in StripeAPI.Types.Mandate Methods toJSON :: MandatePaymentMethod'Variants -> Value # toEncoding :: MandatePaymentMethod'Variants -> Encoding # toJSONList :: [MandatePaymentMethod'Variants] -> Value # toEncodingList :: [MandatePaymentMethod'Variants] -> Encoding #
FromJSON MandatePaymentMethod'Variants Source #
Instance details Defined in StripeAPI.Types.Mandate Methods parseJSON :: Value -> Parser MandatePaymentMethod'Variants # parseJSONList :: Value -> Parser [MandatePaymentMethod'Variants] #

Defines the enum schema located at components.schemas.mandate.properties.status in the specification.

The status of the mandate, which indicates whether it can be used to initiate a payment.

Constructors

MandateStatus'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
MandateStatus'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
MandateStatus'EnumActive	Represents the JSON value `"active"`
MandateStatus'EnumInactive	Represents the JSON value `"inactive"`
MandateStatus'EnumPending	Represents the JSON value `"pending"`

Instances details

Eq MandateStatus' Source #
Instance details Defined in StripeAPI.Types.Mandate Methods (==) :: MandateStatus' -> MandateStatus' -> Bool # (/=) :: MandateStatus' -> MandateStatus' -> Bool #
Show MandateStatus' Source #
Instance details Defined in StripeAPI.Types.Mandate Methods showsPrec :: Int -> MandateStatus' -> ShowS # show :: MandateStatus' -> String # showList :: [MandateStatus'] -> ShowS #
ToJSON MandateStatus' Source #
Instance details Defined in StripeAPI.Types.Mandate Methods toJSON :: MandateStatus' -> Value # toEncoding :: MandateStatus' -> Encoding # toJSONList :: [MandateStatus'] -> Value # toEncodingList :: [MandateStatus'] -> Encoding #
FromJSON MandateStatus' Source #
Instance details Defined in StripeAPI.Types.Mandate Methods parseJSON :: Value -> Parser MandateStatus' # parseJSONList :: Value -> Parser [MandateStatus'] #

Defines the enum schema located at components.schemas.mandate.properties.type in the specification.

The type of the mandate.

Constructors

MandateType'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
MandateType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
MandateType'EnumMultiUse	Represents the JSON value `"multi_use"`
MandateType'EnumSingleUse	Represents the JSON value `"single_use"`

Instances details

Eq MandateType' Source #
Instance details Defined in StripeAPI.Types.Mandate Methods (==) :: MandateType' -> MandateType' -> Bool # (/=) :: MandateType' -> MandateType' -> Bool #
Show MandateType' Source #
Instance details Defined in StripeAPI.Types.Mandate Methods showsPrec :: Int -> MandateType' -> ShowS # show :: MandateType' -> String # showList :: [MandateType'] -> ShowS #
ToJSON MandateType' Source #
Instance details Defined in StripeAPI.Types.Mandate Methods toJSON :: MandateType' -> Value # toEncoding :: MandateType' -> Encoding # toJSONList :: [MandateType'] -> Value # toEncodingList :: [MandateType'] -> Encoding #
FromJSON MandateType' Source #
Instance details Defined in StripeAPI.Types.Mandate Methods parseJSON :: Value -> Parser MandateType' # parseJSONList :: Value -> Parser [MandateType'] #