Web.Stripe.Coupon

Synopsis

Documentation

Represents a coupon in the Stripe system.

Constructors

Coupon
Fields cpnId :: Maybe CpnId cpnDuration :: CpnDuration cpnPercentOff :: CpnPercentOff

Instances

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

newtype CpnId Source

Represents the identifier for a given Coupon in the Stripe system.

Constructors

CpnId
Fields unCpnId :: String

Instances

Show CpnId

data CpnDuration Source

Represents the duration of a coupon. If an interval identifier is not known, UnknownDuration is used to carry the original identifier supplied by Stripe.

Constructors

Once
Repeating Int	Field specifies how long (months) discount is in effect
Forever
UnknownDuration String

Instances

Show CpnDuration

newtype CpnPercentOff Source

Represents the percent off that is applied by a coupon. This must be between 1 and 100.

Constructors

CpnPercentOff
Fields unCpnPercentOff :: Int

Instances

Show CpnPercentOff

newtype CpnMaxRedeems Source

A positive number representing the maximum number of times that a coupon can be redeemed.

Constructors

CpnMaxRedeems
Fields unCpnMaxRedeems :: Int

Instances

Show CpnMaxRedeems

newtype CpnRedeemBy Source

UTC timestamp specifying the last time at which the coupon can be redeemed.

Constructors

CpnRedeemBy
Fields unCpnRedeemBy :: Int

Instances

Show CpnRedeemBy

createCoupon :: MonadIO m => Coupon -> Maybe CpnMaxRedeems -> Maybe CpnRedeemBy -> StripeT m ()Source

Creates a Coupon in the Stripe system.

getCoupon :: MonadIO m => CpnId -> StripeT m Coupon Source

Retrieves a specific Coupon based on its CpnId.

getCoupons :: MonadIO m => Maybe Count -> Maybe Offset -> StripeT m [Coupon]Source

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

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

delCoupon :: MonadIO m => Coupon -> StripeT m Bool Source

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

delCouponById :: MonadIO m => CpnId -> StripeT m Bool Source

Deletes a Coupon, identified by its CpnId, 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

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.