Web.Stripe.Subscription

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

import Web.Stripe         
import Web.Stripe.Subscription
import Web.Stripe.Customer
import Web.Stripe.Plan

main :: IO ()
main = do
  let config = SecretKey "secret_key"
  result <- stripe config $ do
    Customer { customerId = cid } <- createEmptyCustomer
    Plan { planId = pid } <- createPlan (PlanId "free plan")
                     (0 :: Amount) -- free plan
                     (USD :: Currency)
                     (Month :: Inteval)
                     ("sample plan" :: Name)
                     ([] :: MetaData)
  createSubscription cid pid ([] :: MetaData)
  case result of
    Right subscription -> print subscription
    Left stripeError -> print stripeError

API

createSubscription

Arguments

:: CustomerId

The CustomerId upon which to create the Subscription

-> PlanId

The PlanId to associate the Subscription with

-> MetaData

The MetaData associated with the Subscription

-> Stripe Subscription

Create a Subscription by CustomerId and PlanId

getSubscription

Arguments

:: CustomerId

The CustomerId of the Subscription

-> SubscriptionId

The SubscriptionId of the Subscription to retrieve

-> Stripe Subscription

Retrieve a Subscription by CustomerId and SubscriptionId

getSubscriptionExpandable

Arguments

:: CustomerId

The CustomerId of the Subscription to retrieve

-> SubscriptionId

The SubscriptionId of the Subscription to retrieve

-> ExpandParams

The ExpandParams of the object to expand

-> Stripe Subscription

Retrieve a Subscription by CustomerId and SubscriptionId with ExpandParams

getSubscriptions

Arguments

:: CustomerId

The CustomerId of the Subscriptions to retrieve

-> Limit

Defaults to 10 if Nothing specified

-> StartingAfter SubscriptionId

Paginate starting after the following CustomerId

-> EndingBefore SubscriptionId

Paginate ending before the following CustomerId

-> Stripe (StripeList Subscription)

Retrieve active Subscriptions

getSubscriptionsExpandable

Arguments

:: CustomerId

The CustomerId of the Subscriptions to retrieve

-> Limit

Defaults to 10 if Nothing specified

-> StartingAfter SubscriptionId

Paginate starting after the following CustomerId

-> EndingBefore SubscriptionId

Paginate ending before the following CustomerId

-> ExpandParams

The ExpandParams of the object to expand

-> Stripe (StripeList Subscription)

Retrieve active Subscriptions

updateSubscription

Arguments

:: CustomerId

The CustomerId of the Subscription to update

-> SubscriptionId

The SubscriptionId of the Subscription to update

-> Maybe CouponId

Optional: The Coupon of the Subscription to update

-> MetaData

-> Stripe Subscription

Update a Subscription by CustomerId and SubscriptionId

cancelSubscription

Arguments

:: CustomerId

The CustomerId of the Subscription to cancel

-> SubscriptionId

The SubscriptionId of the Subscription to cancel

-> Bool

Flag set to true will delay cancellation until end of current period, default False

-> Stripe Subscription

Delete a Subscription by CustomerId and SubscriptionId

Types

data Subscription

Subscription Object

Constructors

Subscription

Fields

subscriptionId :: SubscriptionId

subscriptionPlan :: Plan

subscriptionObject :: Text

subscriptionStart :: UTCTime

subscriptionStatus :: SubscriptionStatus

subscriptionCustomerId :: CustomerId

subscriptionCancelAtPeriodEnd :: Bool

subscriptionCurrentPeriodStart :: UTCTime

subscriptionCurrentPeriodEnd :: UTCTime

subscriptionEndedAt :: Maybe UTCTime

subscriptionTrialStart :: Maybe UTCTime

subscriptionTrialEnd :: Maybe UTCTime

subscriptionCanceledAt :: Maybe UTCTime

subscriptionQuantity :: Quantity

subscriptionApplicationFeePercent :: Maybe Double

subscriptionDiscount :: Maybe Discount

subscriptionMetaData :: MetaData

Instances

Eq Subscription

Show Subscription

FromJSON Subscription

JSON Instance for Subscription

newtype SubscriptionId

SubscriptionId for a Subscription

Constructors

SubscriptionId Text

Instances

Eq SubscriptionId

Show SubscriptionId

data SubscriptionStatus

Status of a Subscription

Constructors

Trialing

Active

PastDue

Canceled

UnPaid

Instances

Eq SubscriptionStatus

Show SubscriptionStatus

FromJSON SubscriptionStatus

JSON Instance for SubscriptionStatus

data CustomerId

CustomerId for a Customer

Constructors

CustomerId Text

ExpandedCustomer Customer

Instances

Eq CustomerId

Show CustomerId

FromJSON CustomerId

JSON Instance for CustomerId

newtype CouponId

CouponId for a Coupon

Constructors

CouponId Text

Instances

Eq CouponId

Show CouponId

data Coupon

Coupon Object

Constructors

Coupon

Fields

couponId :: CouponId

couponCreated :: UTCTime

couponPercentOff :: Maybe Int

couponAmountOff :: Maybe Int

couponCurrency :: Maybe Currency

couponLiveMode :: Bool

couponDuration :: Duration

couponRedeemBy :: Maybe UTCTime

couponMaxRedemptions :: Maybe Int

couponTimesRedeemed :: Maybe Int

couponDurationInMonths :: Maybe Int

couponValid :: Bool

couponMetaData :: MetaData

Instances

Eq Coupon

Show Coupon

FromJSON Coupon

JSON Instance for Coupon

newtype PlanId

PlanId for a Plan

Constructors

PlanId Text

Instances

Eq PlanId

Show PlanId

data StripeList a

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)

Show a => Show (StripeList a)

FromJSON a => FromJSON (StripeList a)

JSON Instance for StripeList