Copyright	(c) David Johnson, 2014
Maintainer	djohnson.m@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Web.Stripe.Customer

Contents

API
Types

Description

https://stripe.com/docs/api#customers

{-# LANGUAGE OverloadedStrings #-}
import Web.Stripe
import Web.Stripe.Customer

main :: IO ()
main = do
  let config = StripeConfig (StripeKey "secret_key")
  result <- stripe config createCustomer
  case result of
    Right customer    -> print customer
    Left  stripeError -> print stripeError

Synopsis

API

createCustomer :: StripeRequest CreateCustomer Source

Create a customer

data GetCustomer Source

Instances

StripeHasParam GetCustomer ExpandParams Source
type StripeReturn GetCustomer = Customer Source

getCustomer Source

Arguments

:: CustomerId	`CustomerId` of `Customer` to retrieve
-> StripeRequest GetCustomer

Retrieve a customer

updateCustomer Source

Arguments

:: CustomerId	`CustomerId` of `Customer` to update
-> StripeRequest UpdateCustomer

Update a Customer

data DeleteCustomer Source

Deletes the specified Customer

Instances

type StripeReturn DeleteCustomer = StripeDeleteResult Source

deleteCustomer Source

Arguments

:: CustomerId	The `CustomerId` of the `Customer` to delete
-> StripeRequest DeleteCustomer

getCustomers :: StripeRequest GetCustomers Source

Retrieve up to 100 customers at a time

Types

newtype AccountBalance Source

AccountBalance for a Customer

Constructors

AccountBalance Int

newtype CardNumber Source

Number associated with a Card

Constructors

CardNumber Text

Instances

Eq CardNumber Source
Data CardNumber Source
Ord CardNumber Source
Read CardNumber Source
Show CardNumber Source
ToStripeParam CardNumber Source

data Customer Source

Customer object

Constructors

Customer
Fields 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
Fields deletedCustomer :: Maybe Bool deletedCustomerId :: CustomerId

Instances

Eq Customer Source
Data Customer Source
Ord Customer Source
Read Customer Source
Show Customer Source
FromJSON Customer Source	JSON Instance for `Customer`

newtype CVC Source

CVC for a Card

Constructors

CVC Text

Instances

Eq CVC Source
Data CVC Source
Ord CVC Source
Read CVC Source
Show CVC Source
ToStripeParam CVC Source

newtype Description Source

Generic Description for use in constructing API Calls

Constructors

Description Text

newtype Email Source

Email associated with a Customer, Recipient or Charge

Constructors

Email Text

newtype EndingBefore a Source

Pagination Option for StripeList

Constructors

EndingBefore a

Instances

StripeHasParam GetApplicationFees (EndingBefore ApplicationFeeId) Source
StripeHasParam GetApplicationFeeRefunds (EndingBefore RefundId) Source
StripeHasParam GetBalanceTransactionHistory (EndingBefore TransactionId) Source
StripeHasParam GetRecipientCards (EndingBefore CardId) Source
StripeHasParam GetCustomerCards (EndingBefore CardId) Source
StripeHasParam GetCharges (EndingBefore ChargeId) Source
StripeHasParam GetCoupons (EndingBefore CouponId) Source
StripeHasParam GetCustomers (EndingBefore CustomerId) Source
StripeHasParam GetEvents (EndingBefore EventId) Source
StripeHasParam GetInvoiceLineItems (EndingBefore InvoiceLineItemId) Source
StripeHasParam GetInvoices (EndingBefore InvoiceId) Source
StripeHasParam GetInvoiceItems (EndingBefore InvoiceItemId) Source
StripeHasParam GetPlans (EndingBefore PlanId) Source
StripeHasParam GetRecipients (EndingBefore RecipientId) Source
StripeHasParam GetRefunds (EndingBefore RefundId) Source
StripeHasParam GetSubscriptions (EndingBefore SubscriptionId) Source
StripeHasParam GetTransfers (EndingBefore TransferId) Source
Eq a => Eq (EndingBefore a) Source
Data a => Data (EndingBefore a) Source
Ord a => Ord (EndingBefore a) Source
Read a => Read (EndingBefore a) Source
Show a => Show (EndingBefore a) Source
ToStripeParam param => ToStripeParam (EndingBefore param) Source

newtype ExpandParams Source

Type of Expansion Parameters for use on Stripe objects

Constructors

ExpandParams
Fields getExpandParams :: [Text]

Instances

Eq ExpandParams Source
Data ExpandParams Source
Ord ExpandParams Source
Read ExpandParams Source
Show ExpandParams Source
ToStripeParam ExpandParams Source
StripeHasParam GetApplicationFees ExpandParams Source
StripeHasParam GetApplicationFee ExpandParams Source
StripeHasParam GetApplicationFeeRefunds ExpandParams Source
StripeHasParam GetApplicationFeeRefund ExpandParams Source
StripeHasParam GetBalanceTransaction ExpandParams Source
StripeHasParam GetRecipientCards ExpandParams Source
StripeHasParam GetCustomerCards ExpandParams Source
StripeHasParam GetRecipientCard ExpandParams Source
StripeHasParam GetCustomerCard ExpandParams Source
StripeHasParam GetCharges ExpandParams Source
StripeHasParam GetCharge ExpandParams Source
StripeHasParam GetCustomers ExpandParams Source
StripeHasParam GetCustomer ExpandParams Source
StripeHasParam GetInvoices ExpandParams Source
StripeHasParam GetInvoice ExpandParams Source
StripeHasParam GetInvoiceItems ExpandParams Source
StripeHasParam GetInvoiceItem ExpandParams Source
StripeHasParam GetRecipients ExpandParams Source
StripeHasParam GetRecipient ExpandParams Source
StripeHasParam GetRefunds ExpandParams Source
StripeHasParam GetRefund ExpandParams Source
StripeHasParam GetSubscriptions ExpandParams Source
StripeHasParam GetSubscription ExpandParams Source
StripeHasParam GetTransfers ExpandParams Source
StripeHasParam GetTransfer ExpandParams Source

newtype ExpMonth Source

Expiration Month for a Card

Constructors

ExpMonth Int

newtype ExpYear Source

Expiration Year for a Card

Constructors

ExpYear Int

newtype Limit Source

Pagination Option for StripeList

Constructors

Limit Int

Instances

Eq Limit Source
Data Limit Source
Ord Limit Source
Read Limit Source
Show Limit Source
ToStripeParam Limit Source
StripeHasParam GetApplicationFees Limit Source
StripeHasParam GetApplicationFeeRefunds Limit Source
StripeHasParam GetBalanceTransactionHistory Limit Source
StripeHasParam GetRecipientCards Limit Source
StripeHasParam GetCustomerCards Limit Source
StripeHasParam GetCharges Limit Source
StripeHasParam GetCoupons Limit Source
StripeHasParam GetCustomers Limit Source
StripeHasParam GetEvents Limit Source
StripeHasParam GetInvoiceLineItems Limit Source
StripeHasParam GetInvoices Limit Source
StripeHasParam GetInvoiceItems Limit Source
StripeHasParam GetPlans Limit Source
StripeHasParam GetRecipients Limit Source
StripeHasParam GetRefunds Limit Source
StripeHasParam GetSubscriptions Limit Source
StripeHasParam GetTransfers Limit Source

newtype MetaData Source

Type of MetaData for use on Stripe objects

Constructors

MetaData [(Text, Text)]

Instances

Eq MetaData Source
Data MetaData Source
Ord MetaData Source
Read MetaData Source
Show MetaData Source
FromJSON MetaData Source
ToStripeParam MetaData Source
StripeHasParam UpdateApplicationFeeRefund MetaData Source
StripeHasParam CreateApplicationFeeRefund MetaData Source
StripeHasParam UpdateCharge MetaData Source
StripeHasParam CreateCharge MetaData Source
StripeHasParam UpdateCoupon MetaData Source
StripeHasParam CreateCoupon MetaData Source
StripeHasParam UpdateCustomer MetaData Source
StripeHasParam CreateCustomer MetaData Source
StripeHasParam UpdateDispute MetaData Source
StripeHasParam UpdateInvoice MetaData Source
StripeHasParam CreateInvoice MetaData Source
StripeHasParam UpdateInvoiceItem MetaData Source
StripeHasParam CreateInvoiceItem MetaData Source
StripeHasParam UpdatePlan MetaData Source
StripeHasParam CreatePlan MetaData Source
StripeHasParam UpdateRecipient MetaData Source
StripeHasParam CreateRecipient MetaData Source
StripeHasParam UpdateRefund MetaData Source
StripeHasParam CreateRefund MetaData Source
StripeHasParam UpdateSubscription MetaData Source
StripeHasParam CreateSubscription MetaData Source
StripeHasParam UpdateTransfer MetaData Source
StripeHasParam CreateTransfer MetaData Source

mkNewCard :: CardNumber -> ExpMonth -> ExpYear -> NewCard Source

create a NewCard with only the required fields

data NewCard Source

NewCard contains the data needed to create a new Card

Constructors

NewCard

newtype PlanId Source

PlanId for a Plan

Constructors

PlanId Text

newtype Quantity Source

Generic Quantity type to be used with Customer, Subscription and InvoiceLineItem API requests

Constructors

Quantity Int

newtype StartingAfter a Source

Pagination Option for StripeList

Constructors

StartingAfter a

Instances

StripeHasParam GetApplicationFees (StartingAfter ApplicationFeeId) Source
StripeHasParam GetApplicationFeeRefunds (StartingAfter RefundId) Source
StripeHasParam GetBalanceTransactionHistory (StartingAfter TransactionId) Source
StripeHasParam GetRecipientCards (StartingAfter CardId) Source
StripeHasParam GetCustomerCards (StartingAfter CardId) Source
StripeHasParam GetCharges (StartingAfter ChargeId) Source
StripeHasParam GetCoupons (StartingAfter CouponId) Source
StripeHasParam GetCustomers (StartingAfter CustomerId) Source
StripeHasParam GetEvents (StartingAfter EventId) Source
StripeHasParam GetInvoiceLineItems (StartingAfter InvoiceLineItemId) Source
StripeHasParam GetInvoices (StartingAfter InvoiceId) Source
StripeHasParam GetInvoiceItems (StartingAfter InvoiceItemId) Source
StripeHasParam GetPlans (StartingAfter PlanId) Source
StripeHasParam GetRecipients (StartingAfter RecipientId) Source
StripeHasParam GetRefunds (StartingAfter RefundId) Source
StripeHasParam GetSubscriptions (StartingAfter SubscriptionId) Source
StripeHasParam GetTransfers (StartingAfter TransferId) Source
Eq a => Eq (StartingAfter a) Source
Data a => Data (StartingAfter a) Source
Ord a => Ord (StartingAfter a) Source
Read a => Read (StartingAfter a) Source
Show a => Show (StartingAfter a) Source
ToStripeParam param => ToStripeParam (StartingAfter param) Source

data StripeDeleteResult Source

JSON returned from a Stripe deletion request

Constructors

StripeDeleteResult
Fields deleted :: Bool deletedId :: Maybe Text

Instances

Eq StripeDeleteResult Source
Data StripeDeleteResult Source
Ord StripeDeleteResult Source
Read StripeDeleteResult Source
Show StripeDeleteResult Source
FromJSON StripeDeleteResult Source	JSON Instance for `StripeDeleteResult`

data StripeList a Source

Generic handling of Stripe JSON arrays

Constructors

StripeList
Fields list :: [a] stripeUrl :: Text object :: Text totalCount :: Maybe Int hasMore :: Bool

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 `StripeList`

newtype TrialEnd Source

TrialEnd for a Plan

Constructors

TrialEnd UTCTime

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
type StripeReturn CreateCustomer = Customer 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
type StripeReturn UpdateCustomer = Customer Source

Eq AccountBalance Source
Data AccountBalance Source
Ord AccountBalance Source
Read AccountBalance Source
Show AccountBalance Source
ToStripeParam AccountBalance Source
StripeHasParam UpdateCustomer AccountBalance Source
StripeHasParam CreateCustomer AccountBalance Source

Eq CardId Source
Data CardId Source
Ord CardId Source
Read CardId Source
Show CardId Source
FromJSON CardId Source	JSON Instance for `CardId`
ToStripeParam CardId Source
StripeHasParam UpdateRecipient CardId Source
StripeHasParam CreateRecipient CardId Source
StripeHasParam UpdateSubscription CardId Source
StripeHasParam CreateSubscription CardId Source
StripeHasParam CreateTransfer CardId Source
StripeHasParam GetRecipientCards (EndingBefore CardId) Source
StripeHasParam GetRecipientCards (StartingAfter CardId) Source
StripeHasParam GetCustomerCards (EndingBefore CardId) Source
StripeHasParam GetCustomerCards (StartingAfter CardId) Source
type ExpandsTo CardId = Card Source

Eq CouponId Source
Data CouponId Source
Ord CouponId Source
Read CouponId Source
Show CouponId Source
ToStripeParam CouponId Source
StripeHasParam UpdateCustomer CouponId Source
StripeHasParam CreateCustomer CouponId Source
StripeHasParam UpdateSubscription CouponId Source
StripeHasParam CreateSubscription CouponId Source
StripeHasParam GetCoupons (EndingBefore CouponId) Source
StripeHasParam GetCoupons (StartingAfter CouponId) Source

StripeHasParam GetCustomers ExpandParams Source
StripeHasParam GetCustomers Limit Source
StripeHasParam GetCustomers Created Source
StripeHasParam GetCustomers (EndingBefore CustomerId) Source
StripeHasParam GetCustomers (StartingAfter CustomerId) Source
type StripeReturn GetCustomers = StripeList Customer Source

Eq Created Source
Data Created Source
Ord Created Source
Read Created Source
Show Created Source
ToStripeParam Created Source
StripeHasParam GetApplicationFees Created Source
StripeHasParam GetBalanceTransactionHistory Created Source
StripeHasParam GetCharges Created Source
StripeHasParam GetCustomers Created Source
StripeHasParam GetEvents Created Source
StripeHasParam GetInvoiceItems Created Source
StripeHasParam GetTransfers Created Source
StripeHasParam GetBalanceTransactionHistory (TimeRange Created) Source

Eq CustomerId Source
Data CustomerId Source
Ord CustomerId Source
Read CustomerId Source
Show CustomerId Source
FromJSON CustomerId Source	JSON Instance for `CustomerId`
ToStripeParam CustomerId Source
StripeHasParam GetCharges CustomerId Source
StripeHasParam CreateCharge CustomerId Source
StripeHasParam GetInvoiceLineItems CustomerId Source
StripeHasParam GetInvoiceItems CustomerId Source
StripeHasParam CreateCardToken CustomerId Source
StripeHasParam GetCustomers (EndingBefore CustomerId) Source
StripeHasParam GetCustomers (StartingAfter CustomerId) Source
type ExpandsTo CustomerId = Customer Source

Eq Description Source
Data Description Source
Ord Description Source
Read Description Source
Show Description Source
FromJSON Description Source
ToStripeParam Description Source
StripeHasParam UpdateCharge Description Source
StripeHasParam CreateCharge Description Source
StripeHasParam UpdateCustomer Description Source
StripeHasParam CreateCustomer Description Source
StripeHasParam UpdateInvoice Description Source
StripeHasParam CreateInvoice Description Source
StripeHasParam UpdateInvoiceItem Description Source
StripeHasParam CreateInvoiceItem Description Source
StripeHasParam UpdateRecipient Description Source
StripeHasParam CreateRecipient Description Source
StripeHasParam UpdateTransfer Description Source
StripeHasParam CreateTransfer Description Source

Eq Email Source
Data Email Source
Ord Email Source
Read Email Source
Show Email Source
ToStripeParam Email Source
StripeHasParam UpdateCustomer Email Source
StripeHasParam CreateCustomer Email Source
StripeHasParam UpdateRecipient Email Source
StripeHasParam CreateRecipient Email Source

Eq ExpMonth Source
Data ExpMonth Source
Ord ExpMonth Source
Read ExpMonth Source
Show ExpMonth Source
ToStripeParam ExpMonth Source
StripeHasParam UpdateRecipientCard ExpMonth Source
StripeHasParam UpdateCustomerCard ExpMonth Source

Eq ExpYear Source
Data ExpYear Source
Ord ExpYear Source
Read ExpYear Source
Show ExpYear Source
ToStripeParam ExpYear Source
StripeHasParam UpdateRecipientCard ExpYear Source
StripeHasParam UpdateCustomerCard ExpYear Source

Eq NewCard Source
Data NewCard Source
Ord NewCard Source
Read NewCard Source
Show NewCard Source
ToStripeParam NewCard Source
StripeHasParam CreateCharge NewCard Source
StripeHasParam UpdateCustomer NewCard Source
StripeHasParam CreateCustomer NewCard Source
StripeHasParam UpdateRecipient NewCard Source
StripeHasParam CreateRecipient NewCard Source

Eq PlanId Source
Data PlanId Source
Ord PlanId Source
Read PlanId Source
Show PlanId Source
ToStripeParam PlanId Source
StripeHasParam CreateCustomer PlanId Source
StripeHasParam UpdateSubscription PlanId Source
StripeHasParam GetPlans (EndingBefore PlanId) Source
StripeHasParam GetPlans (StartingAfter PlanId) Source

Eq Quantity Source
Data Quantity Source
Ord Quantity Source
Read Quantity Source
Show Quantity Source
ToStripeParam Quantity Source
StripeHasParam CreateCustomer Quantity Source
StripeHasParam UpdateSubscription Quantity Source
StripeHasParam CreateSubscription Quantity Source

Eq TokenId Source
Data TokenId Source
Ord TokenId Source
Read TokenId Source
Show TokenId Source
ToStripeParam TokenId Source
StripeHasParam CreateCharge TokenId Source
StripeHasParam UpdateCustomer TokenId Source
StripeHasParam CreateCustomer TokenId Source
StripeHasParam UpdateRecipient TokenId Source
StripeHasParam CreateRecipient TokenId Source

Eq TrialEnd Source
Data TrialEnd Source
Ord TrialEnd Source
Read TrialEnd Source
Show TrialEnd Source
ToStripeParam TrialEnd Source
StripeHasParam CreateCustomer TrialEnd Source
StripeHasParam UpdateSubscription TrialEnd Source
StripeHasParam CreateSubscription TrialEnd Source