stripe-core-2.0.0: Stripe API for Haskell - Pure Core

Copyright(c) David Johnson, 2014
Maintainerdjohnson.m@gmail.com
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Web.Stripe.StripeRequest

Contents

Description

 

Synopsis

Types

data Method Source

HTTP Method

The other methods are not required by the Stripe API

Constructors

DELETE 
GET 
POST 

data Expandable id Source

a wrapper for fields which can either be an id or an expanded object

Constructors

Id id

an id such as CardId, AccountId, CustomerId, etc

Expanded (ExpandsTo id)

expanded object such as Card, Account, Customer, etc

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 Expandable

newtype ExpandParams Source

Type of Expansion Parameters for use on Stripe objects

Constructors

ExpandParams 

Fields

getExpandParams :: [Text]
 

newtype Param k v Source

used to set a specific key/value pair when the type is not enough

Constructors

Param (k, v) 

type Params = [(ByteString, ByteString)] Source

HTTP Params

data StripeRequest a Source

Stripe Request holding Method, URL and Params for a Request. Also includes the function needed to decode the response.

Constructors

StripeRequest 

Fields

method :: Method

Method of StripeRequest (i.e. GET, PUT, POST, PUT)

endpoint :: Text

Endpoint of StripeRequest

queryParams :: Params

Query Parameters of StripeRequest

type family StripeReturn a :: * Source

return type of stripe request

Instances

type StripeReturn GetApplicationFees = StripeList ApplicationFee Source 
type StripeReturn GetApplicationFee = ApplicationFee Source 
type StripeReturn GetApplicationFeeRefunds = StripeList ApplicationFeeRefund Source 
type StripeReturn UpdateApplicationFeeRefund = ApplicationFeeRefund Source 
type StripeReturn GetApplicationFeeRefund = ApplicationFeeRefund Source 
type StripeReturn CreateApplicationFeeRefund = ApplicationFeeRefund Source 
type StripeReturn GetBalanceTransactionHistory = StripeList BalanceTransaction Source 
type StripeReturn GetBalanceTransaction = BalanceTransaction Source 
type StripeReturn GetBalance = Balance Source 
type StripeReturn GetRecipientCards = StripeList RecipientCard Source 
type StripeReturn GetCustomerCards = StripeList Card Source 
type StripeReturn DeleteRecipientCard = StripeDeleteResult Source 
type StripeReturn DeleteCustomerCard = StripeDeleteResult Source 
type StripeReturn UpdateRecipientCard = RecipientCard Source 
type StripeReturn UpdateCustomerCard = Card Source 
type StripeReturn GetRecipientCard = RecipientCard Source 
type StripeReturn GetCustomerCard = Card Source 
type StripeReturn CreateRecipientCard = RecipientCard Source 
type StripeReturn CreateCustomerCard = Card Source 
type StripeReturn CreateRecipientCardByToken = RecipientCard Source 
type StripeReturn CreateCustomerCardByToken = Card Source 
type StripeReturn GetCharges = StripeList Charge Source 
type StripeReturn CaptureCharge = Charge Source 
type StripeReturn UpdateCharge = Charge Source 
type StripeReturn GetCharge = Charge Source 
type StripeReturn CreateCharge = Charge Source 
type StripeReturn GetCoupons = StripeList Coupon Source 
type StripeReturn DeleteCoupon = StripeDeleteResult Source 
type StripeReturn UpdateCoupon = Coupon Source 
type StripeReturn GetCoupon = Coupon Source 
type StripeReturn CreateCoupon = Coupon Source 
type StripeReturn GetCustomers = StripeList Customer Source 
type StripeReturn DeleteCustomer = StripeDeleteResult Source 
type StripeReturn UpdateCustomer = Customer Source 
type StripeReturn GetCustomer = Customer Source 
type StripeReturn CreateCustomer = Customer Source 
type StripeReturn DeleteSubscriptionDiscount = StripeDeleteResult Source 
type StripeReturn DeleteCustomerDiscount = StripeDeleteResult Source 
type StripeReturn CloseDispute = Dispute Source 
type StripeReturn UpdateDispute = Dispute Source 
type StripeReturn GetEvents = StripeList Event Source 
type StripeReturn GetEvent = Event Source 
type StripeReturn PayInvoice = Invoice Source 
type StripeReturn UpdateInvoice = Invoice Source 
type StripeReturn GetUpcomingInvoice = Invoice Source 
type StripeReturn GetInvoiceLineItems = StripeList InvoiceLineItem Source 
type StripeReturn GetInvoices = StripeList Invoice Source 
type StripeReturn GetInvoice = Invoice Source 
type StripeReturn CreateInvoice = Invoice Source 
type StripeReturn GetInvoiceItems = StripeList InvoiceItem Source 
type StripeReturn DeleteInvoiceItem = StripeDeleteResult Source 
type StripeReturn UpdateInvoiceItem = InvoiceItem Source 
type StripeReturn GetInvoiceItem = InvoiceItem Source 
type StripeReturn CreateInvoiceItem = InvoiceItem Source 
type StripeReturn GetPlans = StripeList Plan Source 
type StripeReturn DeletePlan = StripeDeleteResult Source 
type StripeReturn UpdatePlan = Plan Source 
type StripeReturn GetPlan = Plan Source 
type StripeReturn CreatePlan = Plan Source 
type StripeReturn GetRecipients = StripeList Recipient Source 
type StripeReturn DeleteRecipient = StripeDeleteResult Source 
type StripeReturn UpdateRecipient = Recipient Source 
type StripeReturn GetRecipient = Recipient Source 
type StripeReturn CreateRecipient = Recipient Source 
type StripeReturn GetRefunds = StripeList Refund Source 
type StripeReturn UpdateRefund = Refund Source 
type StripeReturn GetRefund = Refund Source 
type StripeReturn CreateRefund = Refund Source 
type StripeReturn GetSubscriptions = StripeList Subscription Source 
type StripeReturn CancelSubscription = Subscription Source 
type StripeReturn UpdateSubscription = Subscription Source 
type StripeReturn GetSubscription = Subscription Source 
type StripeReturn CreateSubscription = Subscription Source 
type StripeReturn GetBankAccountToken = Token BankAccount Source 
type StripeReturn GetCardToken = Token Card Source 
type StripeReturn CreateBankAccountToken = Token BankAccount Source 
type StripeReturn CreateCardToken = Token Card Source 
type StripeReturn GetTransfers = StripeList Transfer Source 
type StripeReturn CancelTransfer = Transfer Source 
type StripeReturn UpdateTransfer = Transfer Source 
type StripeReturn GetTransfer = Transfer Source 
type StripeReturn CreateTransfer = Transfer Source 
type StripeReturn GetAccountDetails = Account Source 

class ToStripeParam param => StripeHasParam request param Source

indicate if a request allows an optional parameter

Instances

StripeHasParam GetApplicationFees ExpandParams Source 
StripeHasParam GetApplicationFees Limit Source 
StripeHasParam GetApplicationFees ChargeId Source 
StripeHasParam GetApplicationFees Created Source 
StripeHasParam GetApplicationFee ExpandParams Source 
StripeHasParam GetApplicationFeeRefunds ExpandParams Source 
StripeHasParam GetApplicationFeeRefunds Limit Source 
StripeHasParam UpdateApplicationFeeRefund MetaData Source 
StripeHasParam GetApplicationFeeRefund ExpandParams Source 
StripeHasParam CreateApplicationFeeRefund MetaData Source 
StripeHasParam CreateApplicationFeeRefund Amount Source 
StripeHasParam GetBalanceTransactionHistory Currency Source 
StripeHasParam GetBalanceTransactionHistory Limit Source 
StripeHasParam GetBalanceTransactionHistory TransactionType Source 
StripeHasParam GetBalanceTransactionHistory TransferId Source 
StripeHasParam GetBalanceTransactionHistory Created Source 
StripeHasParam GetBalanceTransactionHistory AvailableOn Source 
StripeHasParam GetBalanceTransaction ExpandParams Source 
StripeHasParam GetRecipientCards ExpandParams Source 
StripeHasParam GetRecipientCards Limit Source 
StripeHasParam GetCustomerCards ExpandParams Source 
StripeHasParam GetCustomerCards Limit Source 
StripeHasParam UpdateRecipientCard Name Source 
StripeHasParam UpdateRecipientCard AddressZip Source 
StripeHasParam UpdateRecipientCard AddressState Source 
StripeHasParam UpdateRecipientCard AddressLine2 Source 
StripeHasParam UpdateRecipientCard AddressLine1 Source 
StripeHasParam UpdateRecipientCard AddressCountry Source 
StripeHasParam UpdateRecipientCard AddressCity Source 
StripeHasParam UpdateRecipientCard ExpYear Source 
StripeHasParam UpdateRecipientCard ExpMonth Source 
StripeHasParam UpdateCustomerCard Name Source 
StripeHasParam UpdateCustomerCard AddressZip Source 
StripeHasParam UpdateCustomerCard AddressState Source 
StripeHasParam UpdateCustomerCard AddressLine2 Source 
StripeHasParam UpdateCustomerCard AddressLine1 Source 
StripeHasParam UpdateCustomerCard AddressCountry Source 
StripeHasParam UpdateCustomerCard AddressCity Source 
StripeHasParam UpdateCustomerCard ExpYear Source 
StripeHasParam UpdateCustomerCard ExpMonth Source 
StripeHasParam GetRecipientCard ExpandParams Source 
StripeHasParam GetCustomerCard ExpandParams Source 
StripeHasParam GetCharges ExpandParams Source 
StripeHasParam GetCharges Limit Source 
StripeHasParam GetCharges CustomerId Source 
StripeHasParam GetCharges Created Source 
StripeHasParam CaptureCharge ReceiptEmail Source 
StripeHasParam CaptureCharge Amount Source 
StripeHasParam UpdateCharge Description Source 
StripeHasParam UpdateCharge MetaData Source 
StripeHasParam GetCharge ExpandParams Source 
StripeHasParam CreateCharge ReceiptEmail Source 
StripeHasParam CreateCharge Description Source 
StripeHasParam CreateCharge MetaData Source 
StripeHasParam CreateCharge TokenId Source 
StripeHasParam CreateCharge ApplicationFeeAmount Source 
StripeHasParam CreateCharge NewCard Source 
StripeHasParam CreateCharge CustomerId Source 
StripeHasParam CreateCharge Capture Source 
StripeHasParam CreateCharge StatementDescription Source 
StripeHasParam GetCoupons Limit Source 
StripeHasParam UpdateCoupon MetaData Source 
StripeHasParam CreateCoupon Currency Source 
StripeHasParam CreateCoupon MetaData Source 
StripeHasParam CreateCoupon DurationInMonths Source 
StripeHasParam CreateCoupon RedeemBy Source 
StripeHasParam CreateCoupon PercentOff Source 
StripeHasParam CreateCoupon MaxRedemptions Source 
StripeHasParam CreateCoupon AmountOff Source 
StripeHasParam GetCustomers ExpandParams Source 
StripeHasParam GetCustomers Limit Source 
StripeHasParam GetCustomers Created Source 
StripeHasParam UpdateCustomer Email Source 
StripeHasParam UpdateCustomer Description Source 
StripeHasParam UpdateCustomer MetaData Source 
StripeHasParam UpdateCustomer TokenId Source 
StripeHasParam UpdateCustomer CouponId Source 
StripeHasParam UpdateCustomer DefaultCard Source 
StripeHasParam UpdateCustomer NewCard Source 
StripeHasParam UpdateCustomer AccountBalance Source 
StripeHasParam GetCustomer ExpandParams Source 
StripeHasParam CreateCustomer Email Source 
StripeHasParam CreateCustomer Quantity Source 
StripeHasParam CreateCustomer Description Source 
StripeHasParam CreateCustomer MetaData Source 
StripeHasParam CreateCustomer TokenId Source 
StripeHasParam CreateCustomer CouponId Source 
StripeHasParam CreateCustomer TrialEnd Source 
StripeHasParam CreateCustomer PlanId Source 
StripeHasParam CreateCustomer NewCard Source 
StripeHasParam CreateCustomer AccountBalance Source 
StripeHasParam UpdateDispute MetaData Source 
StripeHasParam UpdateDispute Evidence Source 
StripeHasParam GetEvents Limit Source 
StripeHasParam GetEvents Created Source 
StripeHasParam UpdateInvoice Description Source 
StripeHasParam UpdateInvoice MetaData Source 
StripeHasParam UpdateInvoice ApplicationFeeId Source 
StripeHasParam UpdateInvoice Forgiven Source 
StripeHasParam UpdateInvoice Closed Source 
StripeHasParam UpdateInvoice StatementDescription Source 
StripeHasParam GetUpcomingInvoice SubscriptionId Source 
StripeHasParam GetInvoiceLineItems Limit Source 
StripeHasParam GetInvoiceLineItems SubscriptionId Source 
StripeHasParam GetInvoiceLineItems CustomerId Source 
StripeHasParam GetInvoices ExpandParams Source 
StripeHasParam GetInvoices Limit Source 
StripeHasParam GetInvoice ExpandParams Source 
StripeHasParam CreateInvoice Description Source 
StripeHasParam CreateInvoice MetaData Source 
StripeHasParam CreateInvoice ApplicationFeeId Source 
StripeHasParam CreateInvoice SubscriptionId Source 
StripeHasParam CreateInvoice StatementDescription Source 
StripeHasParam GetInvoiceItems ExpandParams Source 
StripeHasParam GetInvoiceItems Limit Source 
StripeHasParam GetInvoiceItems CustomerId Source 
StripeHasParam GetInvoiceItems Created Source 
StripeHasParam UpdateInvoiceItem Description Source 
StripeHasParam UpdateInvoiceItem MetaData Source 
StripeHasParam UpdateInvoiceItem Amount Source 
StripeHasParam GetInvoiceItem ExpandParams Source 
StripeHasParam CreateInvoiceItem Description Source 
StripeHasParam CreateInvoiceItem MetaData Source 
StripeHasParam CreateInvoiceItem InvoiceId Source 
StripeHasParam CreateInvoiceItem SubscriptionId Source 
StripeHasParam GetPlans Limit Source 
StripeHasParam UpdatePlan PlanName Source 
StripeHasParam UpdatePlan MetaData Source 
StripeHasParam UpdatePlan StatementDescription Source 
StripeHasParam CreatePlan MetaData Source 
StripeHasParam CreatePlan TrialPeriodDays Source 
StripeHasParam CreatePlan IntervalCount Source 
StripeHasParam CreatePlan StatementDescription Source 
StripeHasParam GetRecipients ExpandParams Source 
StripeHasParam GetRecipients Limit Source 
StripeHasParam GetRecipients IsVerified Source 
StripeHasParam UpdateRecipient Email Source 
StripeHasParam UpdateRecipient Description Source 
StripeHasParam UpdateRecipient Name Source 
StripeHasParam UpdateRecipient MetaData Source 
StripeHasParam UpdateRecipient TokenId Source 
StripeHasParam UpdateRecipient TaxID Source 
StripeHasParam UpdateRecipient NewBankAccount Source 
StripeHasParam UpdateRecipient DefaultCard Source 
StripeHasParam UpdateRecipient NewCard Source 
StripeHasParam UpdateRecipient CardId Source 
StripeHasParam GetRecipient ExpandParams Source 
StripeHasParam CreateRecipient Email Source 
StripeHasParam CreateRecipient Description Source 
StripeHasParam CreateRecipient MetaData Source 
StripeHasParam CreateRecipient TokenId Source 
StripeHasParam CreateRecipient TaxID Source 
StripeHasParam CreateRecipient NewBankAccount Source 
StripeHasParam CreateRecipient NewCard Source 
StripeHasParam CreateRecipient CardId Source 
StripeHasParam GetRefunds ExpandParams Source 
StripeHasParam GetRefunds Limit Source 
StripeHasParam UpdateRefund MetaData Source 
StripeHasParam GetRefund ExpandParams Source 
StripeHasParam CreateRefund MetaData Source 
StripeHasParam CreateRefund Amount Source 
StripeHasParam CreateRefund RefundReason Source 
StripeHasParam CreateRefund RefundApplicationFee Source 
StripeHasParam GetSubscriptions ExpandParams Source 
StripeHasParam GetSubscriptions Limit Source 
StripeHasParam CancelSubscription AtPeriodEnd Source 
StripeHasParam UpdateSubscription Prorate Source 
StripeHasParam UpdateSubscription Quantity Source 
StripeHasParam UpdateSubscription MetaData Source 
StripeHasParam UpdateSubscription ApplicationFeePercent Source 
StripeHasParam UpdateSubscription CouponId Source 
StripeHasParam UpdateSubscription TrialEnd Source 
StripeHasParam UpdateSubscription PlanId Source 
StripeHasParam UpdateSubscription CardId Source 
StripeHasParam GetSubscription ExpandParams Source 
StripeHasParam CreateSubscription Quantity Source 
StripeHasParam CreateSubscription MetaData Source 
StripeHasParam CreateSubscription ApplicationFeePercent Source 
StripeHasParam CreateSubscription CouponId Source 
StripeHasParam CreateSubscription TrialEnd Source 
StripeHasParam CreateSubscription CardId Source 
StripeHasParam CreateCardToken CustomerId Source 
StripeHasParam GetTransfers ExpandParams Source 
StripeHasParam GetTransfers Limit Source 
StripeHasParam GetTransfers RecipientId Source 
StripeHasParam GetTransfers TransferStatus Source 
StripeHasParam GetTransfers Date Source 
StripeHasParam GetTransfers Created Source 
StripeHasParam UpdateTransfer Description Source 
StripeHasParam UpdateTransfer MetaData Source 
StripeHasParam GetTransfer ExpandParams Source 
StripeHasParam CreateTransfer Description Source 
StripeHasParam CreateTransfer MetaData Source 
StripeHasParam CreateTransfer BankAccountId Source 
StripeHasParam CreateTransfer CardId Source 
StripeHasParam CreateTransfer StatementDescription Source 
StripeHasParam GetApplicationFees (EndingBefore ApplicationFeeId) Source 
StripeHasParam GetApplicationFees (StartingAfter ApplicationFeeId) Source 
StripeHasParam GetApplicationFeeRefunds (EndingBefore RefundId) Source 
StripeHasParam GetApplicationFeeRefunds (StartingAfter RefundId) Source 
StripeHasParam GetBalanceTransactionHistory (EndingBefore TransactionId) Source 
StripeHasParam GetBalanceTransactionHistory (StartingAfter TransactionId) Source 
ToStripeParam a => StripeHasParam GetBalanceTransactionHistory (Source a) Source 
StripeHasParam GetBalanceTransactionHistory (TimeRange Created) Source 
StripeHasParam GetBalanceTransactionHistory (TimeRange AvailableOn) Source 
StripeHasParam GetRecipientCards (EndingBefore CardId) Source 
StripeHasParam GetRecipientCards (StartingAfter CardId) Source 
StripeHasParam GetCustomerCards (EndingBefore CardId) Source 
StripeHasParam GetCustomerCards (StartingAfter CardId) Source 
StripeHasParam GetCharges (EndingBefore ChargeId) Source 
StripeHasParam GetCharges (StartingAfter ChargeId) Source 
StripeHasParam GetCoupons (EndingBefore CouponId) Source 
StripeHasParam GetCoupons (StartingAfter CouponId) Source 
StripeHasParam GetCustomers (EndingBefore CustomerId) Source 
StripeHasParam GetCustomers (StartingAfter CustomerId) Source 
StripeHasParam GetEvents (EndingBefore EventId) Source 
StripeHasParam GetEvents (StartingAfter EventId) Source 
StripeHasParam GetInvoiceLineItems (EndingBefore InvoiceLineItemId) Source 
StripeHasParam GetInvoiceLineItems (StartingAfter InvoiceLineItemId) Source 
StripeHasParam GetInvoices (EndingBefore InvoiceId) Source 
StripeHasParam GetInvoices (StartingAfter InvoiceId) Source 
StripeHasParam GetInvoiceItems (EndingBefore InvoiceItemId) Source 
StripeHasParam GetInvoiceItems (StartingAfter InvoiceItemId) Source 
StripeHasParam GetPlans (EndingBefore PlanId) Source 
StripeHasParam GetPlans (StartingAfter PlanId) Source 
StripeHasParam GetRecipients (EndingBefore RecipientId) Source 
StripeHasParam GetRecipients (StartingAfter RecipientId) Source 
StripeHasParam GetRefunds (EndingBefore RefundId) Source 
StripeHasParam GetRefunds (StartingAfter RefundId) Source 
StripeHasParam GetSubscriptions (EndingBefore SubscriptionId) Source 
StripeHasParam GetSubscriptions (StartingAfter SubscriptionId) Source 
StripeHasParam GetTransfers (EndingBefore TransferId) Source 
StripeHasParam GetTransfers (StartingAfter TransferId) Source 

class ToStripeParam param where Source

convert a parameter to a key/value

Instances

ToStripeParam Currency Source 
ToStripeParam ReceiptEmail Source 
ToStripeParam Email Source 
ToStripeParam AtPeriodEnd Source 
ToStripeParam Prorate Source 
ToStripeParam Quantity Source 
ToStripeParam Description Source 
ToStripeParam PlanName Source 
ToStripeParam Name Source 
ToStripeParam ExpandParams Source 
ToStripeParam MetaData Source 
ToStripeParam Limit Source 
ToStripeParam TokenId Source 
ToStripeParam EventId Source 
ToStripeParam TransactionType Source 
ToStripeParam TransactionId Source 
ToStripeParam ApplicationFeeAmount Source 
ToStripeParam ApplicationFeePercent Source 
ToStripeParam ApplicationFeeId Source 
ToStripeParam RecipientType Source 
ToStripeParam TaxID Source 
ToStripeParam RecipientId Source 
ToStripeParam NewBankAccount Source 
ToStripeParam BankAccountId Source 
ToStripeParam TransferStatus Source 
ToStripeParam TransferId Source 
ToStripeParam Evidence Source 
ToStripeParam Forgiven Source 
ToStripeParam Closed Source 
ToStripeParam InvoiceLineItemId Source 
ToStripeParam InvoiceItemId Source 
ToStripeParam InvoiceId Source 
ToStripeParam Amount Source 
ToStripeParam TrialPeriodDays Source 
ToStripeParam IntervalCount Source 
ToStripeParam DurationInMonths Source 
ToStripeParam RedeemBy Source 
ToStripeParam PercentOff Source 
ToStripeParam MaxRedemptions Source 
ToStripeParam AmountOff Source 
ToStripeParam CouponId Source 
ToStripeParam Duration Source 
ToStripeParam Interval Source 
ToStripeParam TrialEnd Source 
ToStripeParam PlanId Source 
ToStripeParam SubscriptionId Source 
ToStripeParam DefaultCard Source 
ToStripeParam NewCard Source 
ToStripeParam IsVerified Source 
ToStripeParam AddressZip Source 
ToStripeParam AddressState Source 
ToStripeParam AddressLine2 Source 
ToStripeParam AddressLine1 Source 
ToStripeParam AddressCountry Source 
ToStripeParam AddressCity Source 
ToStripeParam CVC Source 
ToStripeParam ExpYear Source 
ToStripeParam ExpMonth Source 
ToStripeParam CardNumber Source 
ToStripeParam CardId Source 
ToStripeParam AccountBalance Source 
ToStripeParam CustomerId Source 
ToStripeParam RefundReason Source 
ToStripeParam RefundApplicationFee Source 
ToStripeParam RefundId Source 
ToStripeParam Capture Source 
ToStripeParam StatementDescription Source 
ToStripeParam ChargeId Source 
ToStripeParam Date Source 
ToStripeParam Created Source 
ToStripeParam AvailableOn Source 
ToStripeParam param => ToStripeParam (EndingBefore param) Source 
ToStripeParam param => ToStripeParam (StartingAfter param) Source 
ToStripeParam a => ToStripeParam (Source a) Source 
ToStripeParam a => ToStripeParam (TimeRange a) Source 
ToStripeParam (Param Text Text) Source 

(-&-) :: StripeHasParam request param => StripeRequest request -> param -> StripeRequest request Source

add an optional parameter to a StripeRequest

mkStripeRequest :: Method -> Text -> Params -> StripeRequest a Source

HTTP Params

helper function for building a StripeRequest