Safe Haskell	None

Web.Stripe.Subscription

Synopsis

Documentation

data Subscription Source

Represents a subscription in the Stripe API.

Constructors

Subscription
Fields subId :: SubscriptionId subCustomerId :: CustomerId subPlan :: Plan subStatus :: SubStatus subStart :: UTCTime subTrialStart :: Maybe UTCTime subTrialEnd :: Maybe UTCTime subPeriodStart :: UTCTime Current period start subPeriodEnd :: UTCTime Current period end subDiscount :: Maybe Discount

Instances

Show Subscription
FromJSON Subscription	Attempts to parse JSON into a `Subscription`.

newtype SubscriptionId Source

Constructors

SubscriptionId
Fields unSubscriptionId :: Text

Instances

Eq SubscriptionId
Show SubscriptionId

data SubStatus Source

Describes the various stages that a

Constructors

Trialing
Active
PastDue
Unpaid
Canceled
UnknownStatus Text

Instances

Eq SubStatus
Show SubStatus

newtype SubProrate Source

A boolean flag that determines whether or not to prorate switching plans during a billing cycle.

Constructors

SubProrate
Fields unSubProrate :: Bool

Instances

Eq SubProrate
Show SubProrate

newtype SubTrialEnd Source

UTC integer timestamp representing the end of the trial period that the customer receives before being charged for the first time.

Constructors

SubTrialEnd
Fields unSubTrialEnd :: Int

Instances

Eq SubTrialEnd
Show SubTrialEnd

newtype SubAtPeriodEnd Source

A boolean flag that determines whether or not the cancellation of the Subscription should be delayed until the end of the current period.

Constructors

SubAtPeriodEnd
Fields unSubAtPeriodEnd :: Bool

Instances

Eq SubAtPeriodEnd
Show SubAtPeriodEnd

createSub :: MonadIO m => CustomerId -> PlanId -> Maybe CpnId -> Maybe SubTrialEnd -> StripeT m Subscription Source

Create a new Subscription. Limitations: does not yet support passing a card, quantity, or application fee

updateSubRCard :: MonadIO m => RequestCard -> CustomerId -> PlanId -> Maybe CpnId -> Maybe SubProrate -> Maybe SubTrialEnd -> StripeT m Subscription Source

Update the subscription associated with a Customer, identified by CustomerId, in the Stripe system.

If SubTrialEnd is provided, this will override the default trial period of the plan to which the customer is subscribed.

updateSubToken :: MonadIO m => TokenId -> CustomerId -> PlanId -> Maybe CpnId -> Maybe SubProrate -> Maybe SubTrialEnd -> StripeT m Subscription Source

Behaves precisely like updateSubRCard, but uses a Token, identified by TokenId, rather than a RequestCard.

updateSub :: MonadIO m => [(ByteString, ByteString)] -> CustomerId -> PlanId -> Maybe CpnId -> Maybe SubProrate -> Maybe SubTrialEnd -> StripeT m Subscription Source

Internal convenience function to update a Subscription.

cancelSub :: MonadIO m => CustomerId -> Maybe SubAtPeriodEnd -> StripeT m Subscription Source

Cancels the Subscription associated with a Customer, identified by CustomerId, in the Stripe system.

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
ToJSON UTCTime
FromJSON UTCTime
NFData UTCTime
FormatTime UTCTime
ParseTime UTCTime

data StripeConfig Source

Configuration for the StripeT monad transformer.

Constructors

StripeConfig
Fields stripeSecretKey :: SecretKey stripeCAFile :: FilePath stripeVersion :: StripeVersion

Instances

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

newtype StripeT m a Source

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

Constructors

StripeT (StateT StripeConfig (ErrorT StripeFailure m) a)

Instances

Monad m => MonadError StripeFailure (StripeT m)
Monad m => MonadState StripeConfig (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 => StripeConfig -> StripeT m a -> m (Either StripeFailure a)Source

Runs the StripeT monad transformer with a given StripeConfig. 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.