| Copyright | (c) David Johnson, 2014 |
|---|---|
| Maintainer | djohnson.m@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Web.Stripe.Types
Description
- type family ExpandsTo id :: *
- data Expandable id
- data TimeRange a = TimeRange {}
- emptyTimeRange :: TimeRange a
- newtype AvailableOn = AvailableOn UTCTime
- newtype Created = Created UTCTime
- newtype Date = Date UTCTime
- newtype ChargeId = ChargeId Text
- newtype StatementDescription = StatementDescription Text
- data Charge = Charge {
- chargeId :: ChargeId
- chargeObject :: Text
- chargeCreated :: UTCTime
- chargeLiveMode :: Bool
- chargePaid :: Bool
- chargeAmount :: Int
- chargeCurrency :: Currency
- chargeRefunded :: Bool
- chargeCreditCard :: Card
- chargeCaptured :: Bool
- chargeRefunds :: StripeList Refund
- chargeBalanceTransaction :: Maybe (Expandable TransactionId)
- chargeFailureMessage :: Maybe Text
- chargeFailureCode :: Maybe Text
- chargeAmountRefunded :: Int
- chargeCustomerId :: Maybe (Expandable CustomerId)
- chargeInvoice :: Maybe (Expandable InvoiceId)
- chargeDescription :: Maybe Description
- chargeDispute :: Maybe Dispute
- chargeMetaData :: MetaData
- chargeStatementDescription :: Maybe StatementDescription
- chargeReceiptEmail :: Maybe Text
- chargeReceiptNumber :: Maybe Text
- newtype Capture = Capture {
- getCapture :: Bool
- newtype RefundId = RefundId Text
- data Refund = Refund {}
- newtype RefundApplicationFee = RefundApplicationFee {}
- data RefundReason
- newtype CustomerId = CustomerId Text
- data Customer
- = Customer {
- customerObject :: Text
- customerCreated :: UTCTime
- customerId :: CustomerId
- customerLiveMode :: Bool
- customerDescription :: Maybe Description
- customerEmail :: Maybe Email
- customerDelinquent :: Bool
- customerSubscriptions :: StripeList Subscription
- customerDiscount :: Maybe Discount
- customerAccountBalance :: Int
- customerCards :: StripeList Card
- customerCurrency :: Maybe Currency
- customerDefaultCard :: Maybe (Expandable CardId)
- customerMetaData :: MetaData
- | DeletedCustomer { }
- = Customer {
- newtype AccountBalance = AccountBalance Int
- newtype CardId = CardId Text
- newtype RecipientCardId = RecipientCardId Text
- newtype CardNumber = CardNumber Text
- newtype ExpMonth = ExpMonth Int
- newtype ExpYear = ExpYear Int
- newtype CVC = CVC Text
- newtype AddressCity = AddressCity Text
- newtype AddressCountry = AddressCountry Text
- newtype AddressLine1 = AddressLine1 Text
- newtype AddressLine2 = AddressLine2 Text
- newtype AddressState = AddressState Text
- newtype AddressZip = AddressZip Text
- newtype IsVerified = IsVerified {
- getVerified :: Bool
- data Brand
- = Visa
- | AMEX
- | MasterCard
- | Discover
- | JCB
- | DinersClub
- | Unknown
- data Card = Card {
- cardId :: CardId
- cardObject :: Text
- cardLastFour :: Text
- cardBrand :: Brand
- cardFunding :: Text
- cardExpMonth :: ExpMonth
- cardExpYear :: ExpYear
- cardFingerprint :: Text
- cardCountry :: Text
- cardName :: Maybe Name
- cardAddressLine1 :: Maybe AddressLine1
- cardAddressLine2 :: Maybe AddressLine2
- cardAddressCity :: Maybe AddressCity
- cardAddressState :: Maybe AddressState
- cardAddressZip :: Maybe AddressZip
- cardAddressCountry :: Maybe AddressCountry
- cardCVCCheck :: Maybe Text
- cardAddressLine1Check :: Maybe Text
- cardAddressZipCheck :: Maybe Text
- cardCustomerId :: Maybe (Expandable CustomerId)
- data RecipientCard = RecipientCard {
- recipientCardId :: RecipientCardId
- recipientCardLastFour :: Text
- recipientCardBrand :: Brand
- recipientCardFunding :: Text
- recipientCardExpMonth :: ExpMonth
- recipientCardExpYear :: ExpYear
- recipientCardFingerprint :: Text
- recipientCardCountry :: Country
- recipientCardName :: Maybe Name
- recipientCardAddressLine1 :: Maybe AddressLine1
- recipientCardAddressLine2 :: Maybe AddressLine2
- recipientCardAddressCity :: Maybe AddressCity
- recipientCardAddressState :: Maybe AddressState
- recipientCardAddressZip :: Maybe AddressZip
- recipientCardAddressCountry :: Maybe AddressCountry
- recipientCardCVCCheck :: Maybe Text
- recipientCardAddressLine1Check :: Maybe Text
- recipientCardAddressZipCheck :: Maybe Text
- recipientCardRecipientId :: Maybe (Expandable RecipientId)
- data NewCard = NewCard {
- newCardCardNumber :: CardNumber
- newCardExpMonth :: ExpMonth
- newCardExpYear :: ExpYear
- newCardCVC :: Maybe CVC
- newCardName :: Maybe Name
- newCardAddressLine1 :: Maybe AddressLine1
- newCardAddressLine2 :: Maybe AddressLine2
- newCardAddressCity :: Maybe AddressCity
- newCardAddressZip :: Maybe AddressZip
- newCardAddressState :: Maybe AddressState
- newCardAddressCountry :: Maybe AddressCountry
- mkNewCard :: CardNumber -> ExpMonth -> ExpYear -> NewCard
- data DefaultCard = DefaultCard {}
- newtype SubscriptionId = SubscriptionId {}
- data Subscription = Subscription {
- subscriptionId :: SubscriptionId
- subscriptionPlan :: Plan
- subscriptionObject :: Text
- subscriptionStart :: UTCTime
- subscriptionStatus :: SubscriptionStatus
- subscriptionCustomerId :: Expandable CustomerId
- subscriptionCancelAtPeriodEnd :: Bool
- subscriptionCurrentPeriodStart :: UTCTime
- subscriptionCurrentPeriodEnd :: UTCTime
- subscriptionEndedAt :: Maybe UTCTime
- subscriptionTrialStart :: Maybe UTCTime
- subscriptionTrialEnd :: Maybe UTCTime
- subscriptionCanceledAt :: Maybe UTCTime
- subscriptionQuantity :: Quantity
- subscriptionApplicationFeePercent :: Maybe Double
- subscriptionDiscount :: Maybe Discount
- subscriptionMetaData :: MetaData
- data SubscriptionStatus
- newtype PlanId = PlanId Text
- data Plan = Plan {}
- newtype TrialPeriod = TrialPeriod UTCTime
- newtype TrialEnd = TrialEnd UTCTime
- data Interval
- data Duration
- data Coupon = Coupon {
- couponId :: CouponId
- couponCreated :: UTCTime
- couponPercentOff :: Maybe Int
- couponAmountOff :: Maybe Int
- couponCurrency :: Maybe Currency
- couponLiveMode :: Bool
- couponDuration :: Duration
- couponRedeemBy :: Maybe UTCTime
- couponMaxRedemptions :: Maybe Int
- couponTimesRedeemed :: Maybe Int
- couponDurationInMonths :: Maybe Int
- couponValid :: Bool
- couponMetaData :: MetaData
- newtype CouponId = CouponId Text
- newtype AmountOff = AmountOff Int
- newtype MaxRedemptions = MaxRedemptions Int
- newtype PercentOff = PercentOff Int
- newtype RedeemBy = RedeemBy UTCTime
- newtype DurationInMonths = DurationInMonths Int
- newtype IntervalCount = IntervalCount Int
- newtype TrialPeriodDays = TrialPeriodDays Int
- newtype Amount = Amount {}
- data Discount = Discount {}
- newtype InvoiceId = InvoiceId Text
- data Invoice = Invoice {
- invoiceDate :: UTCTime
- invoiceId :: Maybe InvoiceId
- invoicePeriodStart :: UTCTime
- invoicePeriodEnd :: UTCTime
- invoiceLineItems :: StripeList InvoiceLineItem
- invoiceSubTotal :: Int
- invoiceTotal :: Int
- invoiceCustomer :: Expandable CustomerId
- invoiceObject :: Text
- invoiceAttempted :: Bool
- invoiceClosed :: Bool
- invoiceForgiven :: Bool
- invoicePaid :: Bool
- invoiceLiveMode :: Bool
- invoiceAttemptCount :: Int
- invoiceAmountDue :: Int
- invoiceCurrency :: Currency
- invoiceStartingBalance :: Int
- invoiceEndingBalance :: Maybe Int
- invoiceNextPaymentAttempt :: Maybe UTCTime
- invoiceWebHooksDeliveredAt :: Maybe UTCTime
- invoiceCharge :: Maybe (Expandable ChargeId)
- invoiceDiscount :: Maybe Discount
- invoiceApplicateFee :: Maybe FeeId
- invoiceSubscription :: Maybe SubscriptionId
- invoiceStatementDescription :: Maybe StatementDescription
- invoiceDescription :: Maybe Description
- invoiceMetaData :: MetaData
- newtype InvoiceItemId = InvoiceItemId Text
- data InvoiceItem = InvoiceItem {
- invoiceItemObject :: Text
- invoiceItemId :: InvoiceItemId
- invoiceItemDate :: UTCTime
- invoiceItemAmount :: Int
- invoiceItemLiveMode :: Bool
- invoiceItemProration :: Bool
- invoiceItemCurrency :: Currency
- invoiceItemCustomer :: Expandable CustomerId
- invoiceItemDescription :: Maybe Description
- invoiceItemInvoice :: Maybe (Expandable InvoiceId)
- invoiceItemQuantity :: Maybe Quantity
- invoiceItemSubscription :: Maybe Subscription
- invoiceItemMetaData :: MetaData
- newtype InvoiceLineItemId = InvoiceLineItemId Text
- data InvoiceLineItemType
- data InvoiceLineItem = InvoiceLineItem {
- invoiceLineItemId :: InvoiceLineItemId
- invoiceLineItemObject :: Text
- invoiceLineItemType :: InvoiceLineItemType
- invoiceLineItemLiveMode :: Bool
- invoiceLineItemAmount :: Int
- invoiceLineItemCurrency :: Currency
- invoiceLineItemProration :: Bool
- invoiceLineItemPeriod :: Period
- invoiceLineItemQuantity :: Maybe Quantity
- invoiceLineItemPlan :: Maybe Plan
- invoiceLineItemDescription :: Maybe Description
- invoiceLineItemMetaData :: MetaData
- data Period = Period {}
- newtype Closed = Closed {}
- newtype Forgiven = Forgiven {
- getForgiven :: Bool
- data DisputeStatus
- data DisputeReason
- data Dispute = Dispute {
- disputeChargeId :: Expandable ChargeId
- disputeAmount :: Int
- disputeCreated :: UTCTime
- disputeStatus :: DisputeStatus
- disputeLiveMode :: Bool
- disputeCurrency :: Currency
- disputeObject :: Text
- disputeReason :: DisputeReason
- disputeIsChargeRefundable :: Bool
- disputeBalanceTransactions :: [BalanceTransaction]
- disputeEvidenceDueBy :: UTCTime
- disputeEvidence :: Maybe Evidence
- disputeMetaData :: MetaData
- newtype Evidence = Evidence Text
- newtype TransferId = TransferId Text
- data TransferStatus
- data TransferType
- data Transfer = Transfer {
- transferId :: TransferId
- transferObject :: Text
- transferCreated :: UTCTime
- transferDate :: UTCTime
- transferLiveMode :: Bool
- transferAmount :: Int
- transferCurrency :: Currency
- transferStatus :: TransferStatus
- transferType :: TransferType
- transferBalanceTransaction :: Expandable TransactionId
- transferDescription :: Maybe Description
- transferBankAccount :: Maybe BankAccount
- transferFailureMessage :: Maybe Text
- transferFailureCode :: Maybe Text
- transferStatementDescription :: Maybe StatementDescription
- transferRecipient :: Maybe (Expandable RecipientId)
- transferMetaData :: MetaData
- data BankAccount = BankAccount {}
- newtype BankAccountId = BankAccountId Text
- data BankAccountStatus
- newtype RoutingNumber = RoutingNumber Text
- newtype Country = Country Text
- newtype AccountNumber = AccountNumber Text
- data NewBankAccount = NewBankAccount {}
- newtype FirstName = FirstName Text
- newtype LastName = LastName Text
- type MiddleInitial = Char
- newtype RecipientId = RecipientId Text
- newtype TaxID = TaxID {}
- data RecipientType
- data Recipient
- = Recipient {
- recipientId :: RecipientId
- recipientObject :: Text
- recipientCreated :: UTCTime
- recipientLiveMode :: Bool
- recipientType :: RecipientType
- recipientDescription :: Maybe Description
- recipientEmail :: Maybe Email
- recipientName :: Name
- recipientVerified :: Bool
- recipientActiveAccount :: Maybe BankAccount
- recipientCards :: StripeList RecipientCard
- recipientDefaultCard :: Maybe (Expandable RecipientCardId)
- | DeletedRecipient { }
- = Recipient {
- newtype ApplicationFeeId = ApplicationFeeId Text
- data ApplicationFee = ApplicationFee {
- applicationFeeId :: ApplicationFeeId
- applicationFeeObjecet :: Text
- applicationFeeCreated :: UTCTime
- applicationFeeLiveMode :: Bool
- applicationFeeAmount :: Int
- applicationFeeCurrency :: Currency
- applicationFeeRefunded :: Bool
- applicationFeeAmountRefunded :: Int
- applicationFeeRefunds :: StripeList Refund
- applicationFeeBalanceTransaction :: Expandable TransactionId
- applicationFeeAccountId :: Expandable AccountId
- applicationFeeApplicationId :: ApplicationId
- applicationFeeChargeId :: Expandable ChargeId
- applicationFeeMetaData :: MetaData
- newtype ApplicationFeePercent = ApplicationFeePercent Double
- newtype ApplicationFeeAmount = ApplicationFeeAmount Integer
- newtype ApplicationId = ApplicationId Text
- newtype FeeId = FeeId Text
- data ApplicationFeeRefund = ApplicationFeeRefund {
- applicationFeeRefundId :: RefundId
- applicationFeeRefundAmount :: Int
- applicationFeeRefundCurrency :: Currency
- applicationFeeRefundCreated :: UTCTime
- applicationFeeRefundObject :: Text
- applicationFeeRefundBalanceTransaction :: Maybe (Expandable TransactionId)
- applicationFeeRefundFee :: FeeId
- applicationFeeRefundMetaData :: MetaData
- newtype AccountId = AccountId Text
- data Account = Account {
- accountId :: AccountId
- accountEmail :: Email
- accountStatementDescriptor :: Maybe Description
- accountDisplayName :: Maybe Text
- accountTimeZone :: Text
- accountDetailsSubmitted :: Bool
- accountChargeEnabled :: Bool
- accountTransferEnabled :: Bool
- accountCurrenciesSupported :: [Currency]
- accountDefaultCurrency :: Currency
- accountCountry :: Text
- accountObject :: Text
- accountBusinessName :: Maybe Text
- accountBusinessURL :: Maybe Text
- accountBusinessLogo :: Maybe Text
- accountSupportPhone :: Maybe Text
- data Balance = Balance {}
- data BalanceAmount = BalanceAmount {}
- data BalanceTransaction = BalanceTransaction {
- balanceTransactionId :: TransactionId
- balanceTransactionObject :: Text
- balanceTransactionAmount :: Int
- balanceTransactionCurrency :: Currency
- balanceTransactionNet :: Int
- balanceTransactionType :: TransactionType
- balanceTransactionCreated :: UTCTime
- balanceTransactionAvailableOn :: UTCTime
- balanceTransactionStatus :: Text
- balanceTransactionFee :: Int
- balanceTransactionFeeDetails :: [FeeDetails]
- balanceTransactionFeeSource :: Expandable ChargeId
- balanceTransactionFeeDescription :: Maybe Description
- newtype TransactionId = TransactionId Text
- data FeeDetails = FeeDetails {}
- newtype Source a = Source {
- getSource :: a
- data TransactionType
- data EventType
- = AccountUpdatedEvent
- | AccountApplicationDeauthorizedEvent
- | ApplicationFeeCreatedEvent
- | ApplicationFeeRefundedEvent
- | BalanceAvailableEvent
- | ChargeSucceededEvent
- | ChargeFailedEvent
- | ChargeRefundedEvent
- | ChargeCapturedEvent
- | ChargeUpdatedEvent
- | ChargeDisputeCreatedEvent
- | ChargeDisputeUpdatedEvent
- | ChargeDisputeClosedEvent
- | ChargeDisputeFundsWithdrawnEvent
- | ChargeDisputeFundsReinstatedEvent
- | CustomerCreatedEvent
- | CustomerUpdatedEvent
- | CustomerDeletedEvent
- | CustomerCardCreatedEvent
- | CustomerCardUpdatedEvent
- | CustomerCardDeletedEvent
- | CustomerSubscriptionCreatedEvent
- | CustomerSubscriptionUpdatedEvent
- | CustomerSubscriptionDeletedEvent
- | CustomerSubscriptionTrialWillEndEvent
- | CustomerDiscountCreatedEvent
- | CustomerDiscountUpdatedEvent
- | CustomerDiscountDeletedEvent
- | InvoiceCreatedEvent
- | InvoiceUpdatedEvent
- | InvoicePaymentSucceededEvent
- | InvoicePaymentFailedEvent
- | InvoiceItemCreatedEvent
- | InvoiceItemUpdatedEvent
- | InvoiceItemDeletedEvent
- | PlanCreatedEvent
- | PlanUpdatedEvent
- | PlanDeletedEvent
- | CouponCreatedEvent
- | CouponUpdatedEvent
- | CouponDeletedEvent
- | RecipientCreatedEvent
- | RecipientUpdatedEvent
- | RecipientDeletedEvent
- | TransferCreatedEvent
- | TransferUpdatedEvent
- | TransferCanceledEvent
- | TransferPaidEvent
- | TransferFailedEvent
- | PingEvent
- | UnknownEvent
- newtype EventId = EventId Text
- data EventData
- = TransferEvent Transfer
- | AccountEvent Account
- | AccountApplicationEvent ConnectApp
- | ApplicationFeeEvent ApplicationFee
- | InvoiceEvent Invoice
- | PlanEvent Plan
- | RecipientEvent Recipient
- | CouponEvent Coupon
- | BalanceEvent Balance
- | ChargeEvent Charge
- | DisputeEvent Dispute
- | CustomerEvent Customer
- | CardEvent Card
- | SubscriptionEvent Subscription
- | DiscountEvent Discount
- | InvoiceItemEvent InvoiceItem
- | UnknownEventData
- | Ping
- data Event = Event {}
- data ConnectApp = ConnectApp {}
- newtype TokenId = TokenId Text
- data TokenType
- data Token a = Token {
- tokenId :: TokenId
- tokenLiveMode :: Bool
- tokenCreated :: UTCTime
- tokenUsed :: Bool
- tokenObject :: Text
- tokenType :: TokenType
- tokenData :: a
- data StripeList a = StripeList {}
- newtype Limit = Limit Int
- newtype StartingAfter a = StartingAfter a
- newtype EndingBefore a = EndingBefore a
- data StripeDeleteResult = StripeDeleteResult {}
- newtype MetaData = MetaData [(Text, Text)]
- newtype ExpandParams = ExpandParams {
- getExpandParams :: [Text]
- type ID = Text
- type URL = Text
- newtype Name = Name {}
- newtype PlanName = PlanName {
- getPlanName :: Text
- newtype Description = Description Text
- newtype Quantity = Quantity Int
- newtype Prorate = Prorate Bool
- newtype AtPeriodEnd = AtPeriodEnd Bool
- newtype Email = Email Text
- newtype ReceiptEmail = ReceiptEmail Text
- data Currency
- = AED
- | AFN
- | ALL
- | AMD
- | ANG
- | AOA
- | ARS
- | AUD
- | AWG
- | AZN
- | BAM
- | BBD
- | BDT
- | BGN
- | BIF
- | BMD
- | BND
- | BOB
- | BRL
- | BSD
- | BWP
- | BZD
- | CAD
- | CDF
- | CHF
- | CLP
- | CNY
- | COP
- | CRC
- | CVE
- | CZK
- | DJF
- | DKK
- | DOP
- | DZD
- | EEK
- | EGP
- | ETB
- | EUR
- | FJD
- | FKP
- | GBP
- | GEL
- | GIP
- | GMD
- | GNF
- | GTQ
- | GYD
- | HKD
- | HNL
- | HRK
- | HTG
- | HUF
- | IDR
- | ILS
- | INR
- | ISK
- | JMD
- | JPY
- | KES
- | KGS
- | KHR
- | KMF
- | KRW
- | KYD
- | KZT
- | LAK
- | LBP
- | LKR
- | LRD
- | LSL
- | LTL
- | LVL
- | MAD
- | MDL
- | MGA
- | MKD
- | MNT
- | MOP
- | MRO
- | MUR
- | MVR
- | MWK
- | MXN
- | MYR
- | MZN
- | NAD
- | NGN
- | NIO
- | NOK
- | NPR
- | NZD
- | PAB
- | PEN
- | PGK
- | PHP
- | PKR
- | PLN
- | PYG
- | QAR
- | RON
- | RSD
- | RUB
- | RWF
- | SAR
- | SBD
- | SCR
- | SEK
- | SGD
- | SHP
- | SLL
- | SOS
- | SRD
- | STD
- | SVC
- | SZL
- | THB
- | TJS
- | TOP
- | TRY
- | TTD
- | TWD
- | TZS
- | UAH
- | UGX
- | USD
- | UYU
- | UZS
- | VND
- | VUV
- | WST
- | XAF
- | XCD
- | XOF
- | XPF
- | YER
- | ZAR
- | ZMW
- | UnknownCurrency
- data BitcoinReceiver = BitcoinReceiver {
- btcId :: BitcoinReceiverId
- btcObject :: Text
- btcCreated :: UTCTime
- btcLiveMode :: Bool
- btcActive :: Bool
- btcAmount :: Integer
- btcAmountReceived :: Integer
- btcBitcoinAmount :: Integer
- btcBitcoinAmountReceived :: Integer
- btcBitcoinUri :: Text
- btcCurrency :: Currency
- btcFilled :: Bool
- btcInboundAddress :: Text
- btcUncapturedFunds :: Bool
- btcDescription :: Maybe Text
- btcEmail :: Text
- btcMetadata :: MetaData
- btcRefundAddress :: Maybe Text
- btcTransactions :: Maybe Transactions
- btcPayment :: Maybe PaymentId
- btcCustomer :: Maybe CustomerId
- data Transactions = Transactions {}
- data BitcoinTransaction = BitcoinTransaction {}
- newtype BitcoinTransactionId = BitcoinTransactionId Text
- newtype BitcoinReceiverId = BitcoinReceiverId Text
- newtype PaymentId = PaymentId Text
- showAmount :: Currency -> Int -> String
- currencyDivisor :: Currency -> Int -> Float
Documentation
type family ExpandsTo id :: * Source
Expandable values
maps from an id to an object, e.g. CardId to Card
Instances
| type ExpandsTo TransactionId = BalanceTransaction Source | |
| type ExpandsTo AccountId = Account Source | |
| type ExpandsTo RecipientId = Recipient Source | |
| type ExpandsTo InvoiceItemId = InvoiceItem Source | |
| type ExpandsTo InvoiceId = Invoice Source | |
| type ExpandsTo RecipientCardId = RecipientCard Source | |
| type ExpandsTo CardId = Card Source | |
| type ExpandsTo CustomerId = Customer Source | |
| type ExpandsTo ChargeId = Charge Source |
data Expandable id Source
a wrapper for fields which can either be an id or an expanded object
Instances
| (Eq id, Eq (ExpandsTo id)) => Eq (Expandable id) Source | |
| (Data id, Data (ExpandsTo id)) => Data (Expandable id) Source | |
| (Ord id, Ord (ExpandsTo id)) => Ord (Expandable id) Source | |
| (Read id, Read (ExpandsTo id)) => Read (Expandable id) Source | |
| (Show id, Show (ExpandsTo id)) => Show (Expandable id) Source | |
| (FromJSON id, FromJSON (ExpandsTo id)) => FromJSON (Expandable id) Source | JSON Instance for |
specify a TimeRange
FIXME: this is a little awkward to use. How can we make it moar better?
Instances
| StripeHasParam GetBalanceTransactionHistory (TimeRange Created) Source | |
| StripeHasParam GetBalanceTransactionHistory (TimeRange AvailableOn) Source | |
| Eq a => Eq (TimeRange a) Source | |
| Data a => Data (TimeRange a) Source | |
| Ord a => Ord (TimeRange a) Source | |
| Read a => Read (TimeRange a) Source | |
| Show a => Show (TimeRange a) Source | |
| ToStripeParam a => ToStripeParam (TimeRange a) Source |
emptyTimeRange :: TimeRange a Source
Time range with all values set to Nothing
newtype AvailableOn Source
Constructors
| AvailableOn UTCTime |
Instances
Instances
newtype StatementDescription Source
StatementDescription to be added to a Charge
Constructors
| StatementDescription Text |
Instances
Charge object in Stripe API
Constructors
Capture for Charge
Constructors
| Capture | |
Fields
| |
Instances
newtype RefundApplicationFee Source
Constructors
| RefundApplicationFee | |
Fields | |
data RefundReason Source
Constructors
| RefundDuplicate | |
| RefundFraudulent | |
| RefundRequestedByCustomer |
newtype CustomerId Source
CustomerId for a Customer
Constructors
| CustomerId Text |
Instances
Customer object
Constructors
CardId for a Customer
Instances
Expiration Month for a Card
Expiration Year for a Card
CVC for a Card
Credit / Debit Card Brand
Constructors
| Visa | |
| AMEX | |
| MasterCard | |
| Discover | |
| JCB | |
| DinersClub | |
| Unknown |
Card Object
Constructors
| Card | |
Fields
| |
data RecipientCard Source
RecipientCard object
Constructors
Instances
Constructors
Instances
mkNewCard :: CardNumber -> ExpMonth -> ExpYear -> NewCard Source
create a NewCard with only the required fields
newtype SubscriptionId Source
SubscriptionId for a Subscription
Constructors
| SubscriptionId | |
Fields | |
Instances
data Subscription Source
Subscription Object
Constructors
Instances
data SubscriptionStatus Source
Status of a Subscription
Instances
Plan object
Constructors
| Plan | |
Fields
| |
TrialEnd for a Plan
Interval for Plans
Coupon Duration
Coupon Object
Constructors
| Coupon | |
Fields
| |
Instances
Amount representing a monetary value. Stripe represents pennies as whole numbers i.e. 100 = $1
Instances
Constructors
| Discount | |
Instances
Invoice Object
Constructors
| Invoice | |
Fields
| |
newtype InvoiceItemId Source
Constructors
| InvoiceItemId Text |
Instances
data InvoiceItem Source
InvoiceItem object
Constructors
Instances
| Eq InvoiceItem Source | |
| Data InvoiceItem Source | |
| Ord InvoiceItem Source | |
| Read InvoiceItem Source | |
| Show InvoiceItem Source | |
| FromJSON InvoiceItem Source | JSON Instance for |
newtype InvoiceLineItemId Source
InvoiceLineItemId for an InvoiceLineItem
Constructors
| InvoiceLineItemId Text |
Instances
data InvoiceLineItem Source
InvoiceLineItem Object
Constructors
Instances
Period for an InvoiceLineItem
Closed - invoice closed or not
Forgiven - invoice forgiven or not
Constructors
| Forgiven | |
Fields
| |
data DisputeStatus Source
Status of a Dispute
Constructors
| WarningNeedsResponse | |
| WarningUnderReview | |
| NeedsResponse | |
| UnderReview | |
| ChargeRefunded | |
| Won | |
| Lost |
Instances
data DisputeReason Source
Reason of a Dispute
Constructors
| Duplicate | |
| Fraudulent | |
| SubscriptionCanceled | |
| ProductUnacceptable | |
| ProductNotReceived | |
| Unrecognized | |
| CreditNotProcessed | |
| General |
Instances
Dispute Object
Constructors
newtype TransferId Source
Constructors
| TransferId Text |
Instances
data TransferStatus Source
Status of a Transfer
Constructors
| TransferPaid | |
| TransferPending | |
| TransferCanceled | |
| TransferFailed |
Transfer Object
Constructors
newtype BankAccountId Source
Constructors
| BankAccountId Text |
data BankAccountStatus Source
BankAccountStatus Object
Country
type MiddleInitial = Char Source
Middle Initial of a Recipient
newtype RecipientId Source
RecipientId for a Recipient
Constructors
| RecipientId Text |
Instances
data RecipientType Source
Type of Recipient
Constructors
| Individual | |
| Corporation |
Instances
| Eq RecipientType Source | |
| Data RecipientType Source | |
| Ord RecipientType Source | |
| Read RecipientType Source |
|
| Show RecipientType Source |
|
| FromJSON RecipientType Source | JSON Instance for |
| ToStripeParam RecipientType Source |
Recipient Object
Constructors
newtype ApplicationFeeId Source
Constructors
| ApplicationFeeId Text |
Instances
data ApplicationFee Source
ApplicationFee Object
Constructors
Instances
newtype ApplicationFeePercent Source
ApplicationFeePercent
Constructors
| ApplicationFeePercent Double |
Instances
FeeId for objects with Fees
data ApplicationFeeRefund Source
Application Fee Refunds
Constructors
Account Object
Constructors
Balance Object
Constructors
| Balance | |
Fields
| |
data BalanceTransaction Source
BalanceTransaction Object
Constructors
newtype TransactionId Source
TransactionId of a Transaction
Constructors
| TransactionId Text |
Instances
data FeeDetails Source
FeeDetails Object
Constructors
| FeeDetails | |
Fields | |
Instances
| Eq FeeDetails Source | |
| Data FeeDetails Source | |
| Ord FeeDetails Source | |
| Read FeeDetails Source | |
| Show FeeDetails Source | |
| FromJSON FeeDetails Source | JSON Instance for |
data TransactionType Source
transaction type for BalanceTransaction
Constructors
| ChargeTxn | |
| RefundTxn | |
| AdjustmentTxn | |
| ApplicationFeeTxn | |
| ApplicationFeeRefundTxn | |
| TransferTxn | |
| TransferCancelTxn | |
| TransferFailureTxn |
Instances
Event Types
Constructors
EventData
Constructors
Event Object
Constructors
| Event | |
Fields
| |
data ConnectApp Source
Connect Application
Constructors
| ConnectApp | |
Fields
| |
Instances
| Eq ConnectApp Source | |
| Data ConnectApp Source | |
| Ord ConnectApp Source | |
| Read ConnectApp Source | |
| Show ConnectApp Source | |
| FromJSON ConnectApp Source | Connect Application JSON instance |
Instances
Type of Token
Constructors
| TokenCard | |
| TokenBankAccount |
Token Object
Constructors
| Token | |
Fields
| |
data StripeList a Source
Generic handling of Stripe JSON arrays
Constructors
| StripeList | |
Instances
| Eq a => Eq (StripeList a) Source | |
| Data a => Data (StripeList a) Source | |
| Ord a => Ord (StripeList a) Source | |
| Read a => Read (StripeList a) Source | |
| Show a => Show (StripeList a) Source | |
| FromJSON a => FromJSON (StripeList a) Source | JSON Instance for |
Pagination Option for StripeList
Instances
newtype StartingAfter a Source
Pagination Option for StripeList
Constructors
| StartingAfter a |
Instances
newtype EndingBefore a Source
Pagination Option for StripeList
Constructors
| EndingBefore a |
Instances
data StripeDeleteResult Source
JSON returned from a Stripe deletion request
Type of MetaData for use on Stripe objects
Instances
newtype ExpandParams Source
Type of Expansion Parameters for use on Stripe objects
Constructors
| ExpandParams | |
Fields
| |
Instances
a cardholder's full name
a plan name
Constructors
| PlanName | |
Fields
| |
newtype Description Source
Generic Description for use in constructing API Calls
Constructors
| Description Text |
Instances
Generic Quantity type to be used with Customer,
Subscription and InvoiceLineItem API requests
Prorate
newtype AtPeriodEnd Source
A flag that if set to true will delay the cancellation of the subscription until the end of the current period.
Constructors
| AtPeriodEnd Bool |
Stripe supports 138 currencies
Constructors
| AED | United Arab Emirates Dirham |
| AFN | Afghan Afghani |
| ALL | Albanian Lek |
| AMD | Armenian Dram |
| ANG | Netherlands Antillean Gulden |
| AOA | Angolan Kwanza |
| ARS | Argentine Peso |
| AUD | Australian Dollar |
| AWG | Aruban Florin |
| AZN | Azerbaijani Manat |
| BAM | Bosnia & Herzegovina Convertible Mark |
| BBD | Barbadian Dollar |
| BDT | Bangladeshi Taka |
| BGN | Bulgarian Lev |
| BIF | Burundian Franc |
| BMD | Bermudian Dollar |
| BND | Brunei Dollar |
| BOB | Bolivian Boliviano |
| BRL | Brazilian Real |
| BSD | Bahamian Dollar |
| BWP | Botswana Pula |
| BZD | Belize Dollar |
| CAD | Canadian Dollar |
| CDF | Congolese Franc |
| CHF | Swiss Franc |
| CLP | Chilean Peso |
| CNY | Chinese Renminbi Yuan |
| COP | Colombian Peso |
| CRC | Costa Rican Colón |
| CVE | Cape Verdean Escudo |
| CZK | Czech Koruna |
| DJF | Djiboutian Franc |
| DKK | Danish Krone |
| DOP | Dominican Peso |
| DZD | Algerian Dinar |
| EEK | Estonian Kroon |
| EGP | Egyptian Pound |
| ETB | Ethiopian Birr |
| EUR | Euro |
| FJD | Fijian Dollar |
| FKP | Falkland Islands Pound |
| GBP | British Pound |
| GEL | Georgian Lari |
| GIP | Gibraltar Pound |
| GMD | Gambian Dalasi |
| GNF | Guinean Franc |
| GTQ | Guatemalan Quetzal |
| GYD | Guyanese Dollar |
| HKD | Hong Kong Dollar |
| HNL | Honduran Lempira |
| HRK | Croatian Kuna |
| HTG | Haitian Gourde |
| HUF | Hungarian Forint |
| IDR | Indonesian Rupiah |
| ILS | Israeli New Sheqel |
| INR | Indian Rupee |
| ISK | Icelandic Króna |
| JMD | Jamaican Dollar |
| JPY | Japanese Yen |
| KES | Kenyan Shilling |
| KGS | Kyrgyzstani Som |
| KHR | Cambodian Riel |
| KMF | Comorian Franc |
| KRW | South Korean Won |
| KYD | Cayman Islands Dollar |
| KZT | Kazakhstani Tenge |
| LAK | Lao Kip |
| LBP | Lebanese Pound |
| LKR | Sri Lankan Rupee |
| LRD | Liberian Dollar |
| LSL | Lesotho Loti |
| LTL | Lithuanian Litas |
| LVL | Latvian Lats |
| MAD | Moroccan Dirham |
| MDL | Moldovan Leu |
| MGA | Malagasy Ariary |
| MKD | Macedonian Denar |
| MNT | Mongolian Tögrög |
| MOP | Macanese Pataca |
| MRO | Mauritanian Ouguiya |
| MUR | Mauritian Rupee |
| MVR | Maldivian Rufiyaa |
| MWK | Malawian Kwacha |
| MXN | Mexican Peso |
| MYR | Malaysian Ringgit |
| MZN | Mozambican Metical |
| NAD | Namibian Dollar |
| NGN | Nigerian Naira |
| NIO | Nicaraguan Córdoba |
| NOK | Norwegian Krone |
| NPR | Nepalese Rupee |
| NZD | New Zealand Dollar |
| PAB | Panamanian Balboa |
| PEN | Peruvian Nuevo Sol |
| PGK | Papua New Guinean Kina |
| PHP | Philippine Peso |
| PKR | Pakistani Rupee |
| PLN | Polish Złoty |
| PYG | Paraguayan Guaraní |
| QAR | Qatari Riyal |
| RON | Romanian Leu |
| RSD | Serbian Dinar |
| RUB | Russian Ruble |
| RWF | Rwandan Franc |
| SAR | Saudi Riyal |
| SBD | Solomon Islands Dollar |
| SCR | Seychellois Rupee |
| SEK | Swedish Krona |
| SGD | Singapore Dollar |
| SHP | Saint Helenian Pound |
| SLL | Sierra Leonean Leone |
| SOS | Somali Shilling |
| SRD | Surinamese Dollar |
| STD | São Tomé and Príncipe Dobra |
| SVC | Salvadoran Colón |
| SZL | Swazi Lilangeni |
| THB | Thai Baht |
| TJS | Tajikistani Somoni |
| TOP | Tongan Paʻanga |
| TRY | Turkish Lira |
| TTD | Trinidad and Tobago Dollar |
| TWD | New Taiwan Dollar |
| TZS | Tanzanian Shilling |
| UAH | Ukrainian Hryvnia |
| UGX | Ugandan Shilling |
| USD | United States Dollar |
| UYU | Uruguayan Peso |
| UZS | Uzbekistani Som |
| VND | Vietnamese Đồng |
| VUV | Vanuatu Vatu |
| WST | Samoan Tala |
| XAF | Central African Cfa Franc |
| XCD | East Caribbean Dollar |
| XOF | West African Cfa Franc |
| XPF | Cfp Franc |
| YER | Yemeni Rial |
| ZAR | South African Rand |
| ZMW | Zambian Kwacha |
| UnknownCurrency | Unknown Currency |
data BitcoinReceiver Source
BTC ReceiverObject
Constructors
| BitcoinReceiver | |
Fields
| |
Instances
| Eq BitcoinReceiver Source | |
| Show BitcoinReceiver Source | |
| FromJSON BitcoinReceiver Source | FromJSON for BitcoinReceiverId |
data Transactions Source
Bitcoin Transactions
Constructors
| Transactions | |
Fields | |
Instances
| Eq Transactions Source | |
| Show Transactions Source | |
| FromJSON Transactions Source | Bitcoin Transactions data |
data BitcoinTransaction Source
Bitcoin Transaction
Constructors
| BitcoinTransaction | |
Instances
| Eq BitcoinTransaction Source | |
| Show BitcoinTransaction Source | |
| FromJSON BitcoinTransaction Source | FromJSON BitcoinTransaction |
newtype BitcoinTransactionId Source
BitcoinTransactionId
Constructors
| BitcoinTransactionId Text |
Instances
| Eq BitcoinTransactionId Source | |
| Show BitcoinTransactionId Source | |
| FromJSON BitcoinTransactionId Source | FromJSON BitcoinTransactionId |
newtype BitcoinReceiverId Source
BTC ReceiverId
Constructors
| BitcoinReceiverId Text |
Instances
| Eq BitcoinReceiverId Source | |
| Show BitcoinReceiverId Source | |
| FromJSON BitcoinReceiverId Source | FromJSON for BitcoinReceiverId |
BTC PaymentId
Show an amount accounting for zero currencies
https://support.stripe.com/questions/which-zero-decimal-currencies-does-stripe-support