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

Web.Stripe.Discount

Contents

API
Types

Description

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

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

main :: IO ()
main = do
  let config = StripeConfig (StripeKey "secret_key")
  result <- stripe config $ deleteCustomerDiscount (CustomerId "customer_id")
  case result of
    Right deleteResult -> print deleteResult
    Left  stripeError  -> print stripeError

Synopsis

data DeleteCustomerDiscount
deleteCustomerDiscount :: CustomerId -> StripeRequest DeleteCustomerDiscount
data DeleteSubscriptionDiscount
deleteSubscriptionDiscount :: CustomerId -> SubscriptionId -> StripeRequest DeleteSubscriptionDiscount
data StripeDeleteResult = StripeDeleteResult {
- deleted :: Bool
- deletedId :: Maybe Text
}
newtype CustomerId = CustomerId Text
newtype SubscriptionId = SubscriptionId {
- getSubscriptionId :: Text
}
data Discount = Discount {
- discountCoupon :: Coupon
- discountStart :: UTCTime
- discountEnd :: Maybe UTCTime
- discountCustomer :: Expandable CustomerId
- discountObject :: Text
- discountSubscription :: Maybe SubscriptionId
}

API

data DeleteCustomerDiscount Source #

Instances

type StripeReturn DeleteCustomerDiscount Source #
Instance details Defined in Web.Stripe.Discount type StripeReturn DeleteCustomerDiscount = StripeDeleteResult

deleteCustomerDiscount Source #

Arguments

:: CustomerId	The `Customer` upon which to remove the `Discount`
-> StripeRequest DeleteCustomerDiscount

Delete Customer Discount by CustomerId

data DeleteSubscriptionDiscount Source #

Instances

type StripeReturn DeleteSubscriptionDiscount Source #
Instance details Defined in Web.Stripe.Discount type StripeReturn DeleteSubscriptionDiscount = StripeDeleteResult

deleteSubscriptionDiscount Source #

Arguments

:: CustomerId	The `Customer` to remove the `Discount` from
-> SubscriptionId	The `Subscription` to remove the `Discount` from
-> StripeRequest DeleteSubscriptionDiscount

Delete Subscription Discount by CustomerId and SubscriptionId

Types

data StripeDeleteResult Source #

JSON returned from a Stripe deletion request

Constructors

StripeDeleteResult
Fields deleted :: Bool deletedId :: Maybe Text

Instances

Eq StripeDeleteResult Source #
Instance details Defined in Web.Stripe.Types Methods (==) :: StripeDeleteResult -> StripeDeleteResult -> Bool # (/=) :: StripeDeleteResult -> StripeDeleteResult -> Bool #
Data StripeDeleteResult Source #
Instance details Defined in Web.Stripe.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StripeDeleteResult -> c StripeDeleteResult # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StripeDeleteResult # toConstr :: StripeDeleteResult -> Constr # dataTypeOf :: StripeDeleteResult -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StripeDeleteResult) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StripeDeleteResult) # gmapT :: (forall b. Data b => b -> b) -> StripeDeleteResult -> StripeDeleteResult # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StripeDeleteResult -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StripeDeleteResult -> r # gmapQ :: (forall d. Data d => d -> u) -> StripeDeleteResult -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StripeDeleteResult -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StripeDeleteResult -> m StripeDeleteResult # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StripeDeleteResult -> m StripeDeleteResult # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StripeDeleteResult -> m StripeDeleteResult #
Ord StripeDeleteResult Source #
Instance details Defined in Web.Stripe.Types Methods compare :: StripeDeleteResult -> StripeDeleteResult -> Ordering # (<) :: StripeDeleteResult -> StripeDeleteResult -> Bool # (<=) :: StripeDeleteResult -> StripeDeleteResult -> Bool # (>) :: StripeDeleteResult -> StripeDeleteResult -> Bool # (>=) :: StripeDeleteResult -> StripeDeleteResult -> Bool # max :: StripeDeleteResult -> StripeDeleteResult -> StripeDeleteResult # min :: StripeDeleteResult -> StripeDeleteResult -> StripeDeleteResult #
Read StripeDeleteResult Source #
Instance details Defined in Web.Stripe.Types Methods readsPrec :: Int -> ReadS StripeDeleteResult # readList :: ReadS [StripeDeleteResult] # readPrec :: ReadPrec StripeDeleteResult # readListPrec :: ReadPrec [StripeDeleteResult] #
Show StripeDeleteResult Source #
Instance details Defined in Web.Stripe.Types Methods showsPrec :: Int -> StripeDeleteResult -> ShowS # show :: StripeDeleteResult -> String # showList :: [StripeDeleteResult] -> ShowS #
FromJSON StripeDeleteResult Source #	JSON Instance for `StripeDeleteResult`
Instance details Defined in Web.Stripe.Types Methods parseJSON :: Value -> Parser StripeDeleteResult # parseJSONList :: Value -> Parser [StripeDeleteResult] #

newtype CustomerId Source #

CustomerId for a Customer

Constructors

CustomerId Text

Instances

Eq CustomerId Source #
Instance details Defined in Web.Stripe.Types Methods (==) :: CustomerId -> CustomerId -> Bool # (/=) :: CustomerId -> CustomerId -> Bool #
Data CustomerId Source #
Instance details Defined in Web.Stripe.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CustomerId -> c CustomerId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CustomerId # toConstr :: CustomerId -> Constr # dataTypeOf :: CustomerId -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CustomerId) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CustomerId) # gmapT :: (forall b. Data b => b -> b) -> CustomerId -> CustomerId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CustomerId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CustomerId -> r # gmapQ :: (forall d. Data d => d -> u) -> CustomerId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CustomerId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CustomerId -> m CustomerId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CustomerId -> m CustomerId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CustomerId -> m CustomerId #
Ord CustomerId Source #
Instance details Defined in Web.Stripe.Types Methods compare :: CustomerId -> CustomerId -> Ordering # (<) :: CustomerId -> CustomerId -> Bool # (<=) :: CustomerId -> CustomerId -> Bool # (>) :: CustomerId -> CustomerId -> Bool # (>=) :: CustomerId -> CustomerId -> Bool # max :: CustomerId -> CustomerId -> CustomerId # min :: CustomerId -> CustomerId -> CustomerId #
Read CustomerId Source #
Instance details Defined in Web.Stripe.Types Methods readsPrec :: Int -> ReadS CustomerId # readList :: ReadS [CustomerId] # readPrec :: ReadPrec CustomerId # readListPrec :: ReadPrec [CustomerId] #
Show CustomerId Source #
Instance details Defined in Web.Stripe.Types Methods showsPrec :: Int -> CustomerId -> ShowS # show :: CustomerId -> String # showList :: [CustomerId] -> ShowS #
FromJSON CustomerId Source #	JSON Instance for `CustomerId`
Instance details Defined in Web.Stripe.Types Methods parseJSON :: Value -> Parser CustomerId # parseJSONList :: Value -> Parser [CustomerId] #
ToStripeParam CustomerId Source #
Instance details Defined in Web.Stripe.StripeRequest Methods toStripeParam :: CustomerId -> [(ByteString, ByteString)] -> [(ByteString, ByteString)] Source #
StripeHasParam CreateCardToken CustomerId Source #
Instance details Defined in Web.Stripe.Token
StripeHasParam GetInvoiceItems CustomerId Source #
Instance details Defined in Web.Stripe.InvoiceItem
StripeHasParam GetInvoiceLineItems CustomerId Source #
Instance details Defined in Web.Stripe.Invoice
StripeHasParam GetInvoices CustomerId Source #
Instance details Defined in Web.Stripe.Invoice
StripeHasParam GetCharges CustomerId Source #
Instance details Defined in Web.Stripe.Charge
StripeHasParam CreateCharge CustomerId Source #
Instance details Defined in Web.Stripe.Charge
StripeHasParam GetCustomers (EndingBefore CustomerId) Source #
Instance details Defined in Web.Stripe.Customer
StripeHasParam GetCustomers (StartingAfter CustomerId) Source #
Instance details Defined in Web.Stripe.Customer
type ExpandsTo CustomerId Source #
Instance details Defined in Web.Stripe.Types type ExpandsTo CustomerId = Customer

newtype SubscriptionId Source #

SubscriptionId for a Subscription

Constructors

SubscriptionId
Fields getSubscriptionId :: Text

Instances

Eq SubscriptionId Source #
Instance details Defined in Web.Stripe.Types Methods (==) :: SubscriptionId -> SubscriptionId -> Bool # (/=) :: SubscriptionId -> SubscriptionId -> Bool #
Data SubscriptionId Source #
Instance details Defined in Web.Stripe.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubscriptionId -> c SubscriptionId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubscriptionId # toConstr :: SubscriptionId -> Constr # dataTypeOf :: SubscriptionId -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionId) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubscriptionId) # gmapT :: (forall b. Data b => b -> b) -> SubscriptionId -> SubscriptionId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionId -> r # gmapQ :: (forall d. Data d => d -> u) -> SubscriptionId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SubscriptionId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubscriptionId -> m SubscriptionId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionId -> m SubscriptionId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionId -> m SubscriptionId #
Ord SubscriptionId Source #
Instance details Defined in Web.Stripe.Types Methods compare :: SubscriptionId -> SubscriptionId -> Ordering # (<) :: SubscriptionId -> SubscriptionId -> Bool # (<=) :: SubscriptionId -> SubscriptionId -> Bool # (>) :: SubscriptionId -> SubscriptionId -> Bool # (>=) :: SubscriptionId -> SubscriptionId -> Bool # max :: SubscriptionId -> SubscriptionId -> SubscriptionId # min :: SubscriptionId -> SubscriptionId -> SubscriptionId #
Read SubscriptionId Source #
Instance details Defined in Web.Stripe.Types Methods readsPrec :: Int -> ReadS SubscriptionId # readList :: ReadS [SubscriptionId] # readPrec :: ReadPrec SubscriptionId # readListPrec :: ReadPrec [SubscriptionId] #
Show SubscriptionId Source #
Instance details Defined in Web.Stripe.Types Methods showsPrec :: Int -> SubscriptionId -> ShowS # show :: SubscriptionId -> String # showList :: [SubscriptionId] -> ShowS #
FromJSON SubscriptionId Source #	JSON Instance for `SubscriptionId`
Instance details Defined in Web.Stripe.Types Methods parseJSON :: Value -> Parser SubscriptionId # parseJSONList :: Value -> Parser [SubscriptionId] #
ToStripeParam SubscriptionId Source #
Instance details Defined in Web.Stripe.StripeRequest Methods toStripeParam :: SubscriptionId -> [(ByteString, ByteString)] -> [(ByteString, ByteString)] Source #
StripeHasParam CreateInvoiceItem SubscriptionId Source #
Instance details Defined in Web.Stripe.InvoiceItem
StripeHasParam GetUpcomingInvoice SubscriptionId Source #
Instance details Defined in Web.Stripe.Invoice
StripeHasParam GetInvoiceLineItems SubscriptionId Source #
Instance details Defined in Web.Stripe.Invoice
StripeHasParam CreateInvoice SubscriptionId Source #
Instance details Defined in Web.Stripe.Invoice
StripeHasParam GetSubscriptionsByCustomerId (EndingBefore SubscriptionId) Source #
Instance details Defined in Web.Stripe.Subscription
StripeHasParam GetSubscriptionsByCustomerId (StartingAfter SubscriptionId) Source #
Instance details Defined in Web.Stripe.Subscription
StripeHasParam GetSubscriptions (EndingBefore SubscriptionId) Source #
Instance details Defined in Web.Stripe.Subscription
StripeHasParam GetSubscriptions (StartingAfter SubscriptionId) Source #
Instance details Defined in Web.Stripe.Subscription

data Discount Source #

Discount for Coupon

Constructors

Discount
Fields discountCoupon :: Coupon discountStart :: UTCTime discountEnd :: Maybe UTCTime discountCustomer :: Expandable CustomerId discountObject :: Text discountSubscription :: Maybe SubscriptionId

Instances

Eq Discount Source #
Instance details Defined in Web.Stripe.Types Methods (==) :: Discount -> Discount -> Bool # (/=) :: Discount -> Discount -> Bool #
Data Discount Source #
Instance details Defined in Web.Stripe.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Discount -> c Discount # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Discount # toConstr :: Discount -> Constr # dataTypeOf :: Discount -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Discount) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Discount) # gmapT :: (forall b. Data b => b -> b) -> Discount -> Discount # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Discount -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Discount -> r # gmapQ :: (forall d. Data d => d -> u) -> Discount -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Discount -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Discount -> m Discount # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Discount -> m Discount # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Discount -> m Discount #
Ord Discount Source #
Instance details Defined in Web.Stripe.Types Methods compare :: Discount -> Discount -> Ordering # (<) :: Discount -> Discount -> Bool # (<=) :: Discount -> Discount -> Bool # (>) :: Discount -> Discount -> Bool # (>=) :: Discount -> Discount -> Bool # max :: Discount -> Discount -> Discount # min :: Discount -> Discount -> Discount #
Read Discount Source #
Instance details Defined in Web.Stripe.Types Methods readsPrec :: Int -> ReadS Discount # readList :: ReadS [Discount] # readPrec :: ReadPrec Discount # readListPrec :: ReadPrec [Discount] #
Show Discount Source #
Instance details Defined in Web.Stripe.Types Methods showsPrec :: Int -> Discount -> ShowS # show :: Discount -> String # showList :: [Discount] -> ShowS #
FromJSON Discount Source #	JSON Instance for `Discount`
Instance details Defined in Web.Stripe.Types Methods parseJSON :: Value -> Parser Discount # parseJSONList :: Value -> Parser [Discount] #