Web.Stripe.Customer

Synopsis

Documentation

Represents a customer in the Stripe system.

Constructors

Customer
Fields custId :: CustomerId custEmail :: Email custDescription :: Maybe Description custLive :: Bool custCreated :: UTCTime custActiveCard :: Maybe Card

Instances

Show Customer
JSON Customer	Attempts to parse JSON into a `Customer`.

newtype CustomerId Source

Represents a 'Customer'\'s ID in the Stripe system.

Constructors

CustomerId
Fields unCustomerId :: String

Instances

Show CustomerId

newtype Email Source

Represents a standard email address.

Constructors

Email
Fields unEmail :: String

Instances

Show Email

createCustomer :: MonadIO m => Maybe RequestCard -> Maybe CpnId -> Maybe Email -> Maybe Description -> Maybe PlanId -> Maybe Int -> StripeT m Customer Source

Create a new Customer in the Stripe system.

updateCustomer :: MonadIO m => Customer -> Maybe RequestCard -> Maybe CpnId -> Maybe Email -> Maybe Description -> StripeT m Customer Source

Update an existing Customer in the Stripe system.

updateCustomerById :: MonadIO m => CustomerId -> Maybe RequestCard -> Maybe CpnId -> Maybe Email -> Maybe Description -> StripeT m Customer Source

Update an existing Customer, identified by CustomerId, in the Stripe system.

getCustomer :: MonadIO m => CustomerId -> StripeT m Customer Source

Retrieves a specific Customer based on its CustomerId.

getCustomers :: MonadIO m => Maybe Count -> Maybe Offset -> StripeT m [Customer]Source

Retrieves a list of all Customers. The query can optionally be refined to a specific:

number of charges, via Count and * page of results, via Offset.

delCustomer :: MonadIO m => Customer -> StripeT m Bool Source

Deletes a Customer if it exists. If it does not, an InvalidRequestError will be thrown indicating this.

delCustomerById :: MonadIO m => CustomerId -> StripeT m Bool Source

Deletes a Customer, identified by its CustomerId, if it exists. If it does not, an InvalidRequestError will be thrown indicating this.

newtype Count Source

A maximum number of objects that the Stripe API will return. This value should be between 1 and 100, inclusive.

Constructors

Count
Fields unCount :: Int

Instances

Show Count

newtype Offset Source

A positive integer that is an offset into the array of objects returned by the Stripe API.

Constructors

Offset
Fields unOffset :: Int

Instances

Show Offset

newtype Description Source

Describes an object in the Stripe system.

Constructors

Description
Fields unDescription :: String

Instances

Show Description

data UTCTime

This is the simplest representation of UTC. It consists of the day number, and a time offset from midnight. Note that if a day has a leap second added to it, it will have 86401 seconds.

Constructors

UTCTime
Fields utctDay :: Day the day utctDayTime :: DiffTime the time from midnight, 0 <= t < 86401s (because of leap-seconds)

Instances

Eq UTCTime
Data UTCTime
Ord UTCTime
Read UTCTime
Show UTCTime
Typeable UTCTime
FormatTime UTCTime
ParseTime UTCTime

data SConfig Source

Configuration for the StripeT monad transformer.

Constructors

SConfig
Fields key :: APIKey caFile :: FilePath

Instances

Show SConfig
Monad m => MonadState SConfig (StripeT m)

newtype StripeT m a Source

Defines the monad transformer under which all Stripe REST API resource calls take place.

Constructors

StripeT (StateT SConfig (ErrorT SFailure m) a)

Instances

Monad m => MonadError SFailure (StripeT m)
Monad m => MonadState SConfig (StripeT m)
Monad m => Monad (StripeT m)
Functor m => Functor (StripeT m)
Monad m => MonadPlus (StripeT m)
MonadIO m => MonadIO (StripeT m)

runStripeT :: MonadIO m => SConfig -> StripeT m a -> m (Either SFailure a)Source

Runs the StripeT monad transformer with a given SConfig. This will handle all of the authorization dance steps necessary to utilize the Stripe API.

Its use is demonstrated in other functions, such as query.