stripe-hs-0.3.0.0: Unofficial Stripe client
Safe HaskellNone
LanguageHaskell2010

Stripe.Client

Synopsis

Basics

type ApiKey = Text Source #

Your Stripe API key. Can be obtained from the Stripe dashboard. Format: sk_mode_redacted

data StripeClient Source #

Holds a Manager and your API key.

makeStripeClient Source #

Arguments

:: ApiKey 
-> Manager 
-> Int

Number of automatic retries the library should attempt. See also Stripe Error Handling

-> StripeClient 

Construct a StripeClient. Note that the passed Manager must support https (e.g. via http-client-tls)

data ClientError #

A type representing possible errors in a request

Note that this type substantially changed in 0.12.

Constructors

FailureResponse (RequestF () (BaseUrl, ByteString)) Response

The server returned an error response including the failing request. requestPath includes the BaseUrl and the path of the request.

DecodeFailure Text Response

The body could not be decoded at the expected type

UnsupportedContentType MediaType Response

The content-type of the response is not supported

InvalidContentTypeHeader Response

The content-type header is invalid

ConnectionError SomeException

There was a connection error, and no response was received

Instances

Instances details
Eq ClientError 
Instance details

Defined in Servant.Client.Core.ClientError

Show ClientError 
Instance details

Defined in Servant.Client.Core.ClientError

Generic ClientError 
Instance details

Defined in Servant.Client.Core.ClientError

Associated Types

type Rep ClientError :: Type -> Type #

Exception ClientError 
Instance details

Defined in Servant.Client.Core.ClientError

NFData ClientError

Note: an exception in ConnectionError might not be evaluated fully, We only rnf its showed value.

Instance details

Defined in Servant.Client.Core.ClientError

Methods

rnf :: ClientError -> () #

MonadError ClientError ClientM 
Instance details

Defined in Servant.Client.Internal.HttpClient

type Rep ClientError 
Instance details

Defined in Servant.Client.Core.ClientError

Helper types

newtype TimeStamp #

A UTCTime wrapper that has unix timestamp JSON representation

Constructors

TimeStamp 

Fields

Instances

Instances details
Eq TimeStamp 
Instance details

Defined in Stripe.Resources

Show TimeStamp 
Instance details

Defined in Stripe.Resources

ToJSON TimeStamp 
Instance details

Defined in Stripe.Resources

FromJSON TimeStamp 
Instance details

Defined in Stripe.Resources

ToHttpApiData TimeStamp 
Instance details

Defined in Stripe.Resources

data StripeList a #

A Vector wrapper with an indication is there are more items available through pagination.

Constructors

StripeList 

Fields

Instances

Instances details
Functor StripeList 
Instance details

Defined in Stripe.Resources

Methods

fmap :: (a -> b) -> StripeList a -> StripeList b #

(<$) :: a -> StripeList b -> StripeList a #

Applicative StripeList 
Instance details

Defined in Stripe.Resources

Methods

pure :: a -> StripeList a #

(<*>) :: StripeList (a -> b) -> StripeList a -> StripeList b #

liftA2 :: (a -> b -> c) -> StripeList a -> StripeList b -> StripeList c #

(*>) :: StripeList a -> StripeList b -> StripeList b #

(<*) :: StripeList a -> StripeList b -> StripeList a #

Eq a => Eq (StripeList a) 
Instance details

Defined in Stripe.Resources

Methods

(==) :: StripeList a -> StripeList a -> Bool #

(/=) :: StripeList a -> StripeList a -> Bool #

Show a => Show (StripeList a) 
Instance details

Defined in Stripe.Resources

Semigroup (StripeList a) 
Instance details

Defined in Stripe.Resources

Monoid (StripeList a) 
Instance details

Defined in Stripe.Resources

ToJSON a => ToJSON (StripeList a) 
Instance details

Defined in Stripe.Resources

FromJSON a => FromJSON (StripeList a) 
Instance details

Defined in Stripe.Resources

Customers

data Customer #

Instances

Instances details
Eq Customer 
Instance details

Defined in Stripe.Resources

Show Customer 
Instance details

Defined in Stripe.Resources

ToJSON Customer 
Instance details

Defined in Stripe.Resources

FromJSON Customer 
Instance details

Defined in Stripe.Resources

data CustomerCreate #

Constructors

CustomerCreate 

Instances

Instances details
Eq CustomerCreate 
Instance details

Defined in Stripe.Resources

Show CustomerCreate 
Instance details

Defined in Stripe.Resources

Generic CustomerCreate 
Instance details

Defined in Stripe.Resources

Associated Types

type Rep CustomerCreate :: Type -> Type #

ToForm CustomerCreate 
Instance details

Defined in Stripe.Resources

type Rep CustomerCreate 
Instance details

Defined in Stripe.Resources

type Rep CustomerCreate = D1 ('MetaData "CustomerCreate" "Stripe.Resources" "stripe-servant-0.3.0.0-BDZ8cVxXkVLAWAtVr94due" 'False) (C1 ('MetaCons "CustomerCreate" 'PrefixI 'True) (S1 ('MetaSel ('Just "ccName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ccEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

data CustomerUpdate #

Constructors

CustomerUpdate 

Instances

Instances details
Eq CustomerUpdate 
Instance details

Defined in Stripe.Resources

Show CustomerUpdate 
Instance details

Defined in Stripe.Resources

Generic CustomerUpdate 
Instance details

Defined in Stripe.Resources

Associated Types

type Rep CustomerUpdate :: Type -> Type #

ToForm CustomerUpdate 
Instance details

Defined in Stripe.Resources

type Rep CustomerUpdate 
Instance details

Defined in Stripe.Resources

type Rep CustomerUpdate = D1 ('MetaData "CustomerUpdate" "Stripe.Resources" "stripe-servant-0.3.0.0-BDZ8cVxXkVLAWAtVr94due" 'False) (C1 ('MetaCons "CustomerUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "cuName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cuEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

Product catalog

newtype ProductId #

Constructors

ProductId 

Fields

Instances

Instances details
Eq ProductId 
Instance details

Defined in Stripe.Resources

Show ProductId 
Instance details

Defined in Stripe.Resources

ToJSON ProductId 
Instance details

Defined in Stripe.Resources

FromJSON ProductId 
Instance details

Defined in Stripe.Resources

ToHttpApiData ProductId 
Instance details

Defined in Stripe.Resources

newtype PriceId #

Constructors

PriceId 

Fields

Instances

Instances details
Eq PriceId 
Instance details

Defined in Stripe.Resources

Methods

(==) :: PriceId -> PriceId -> Bool #

(/=) :: PriceId -> PriceId -> Bool #

Show PriceId 
Instance details

Defined in Stripe.Resources

ToJSON PriceId 
Instance details

Defined in Stripe.Resources

FromJSON PriceId 
Instance details

Defined in Stripe.Resources

ToHttpApiData PriceId 
Instance details

Defined in Stripe.Resources

data Product #

Constructors

Product 

Instances

Instances details
Eq Product 
Instance details

Defined in Stripe.Resources

Methods

(==) :: Product -> Product -> Bool #

(/=) :: Product -> Product -> Bool #

Show Product 
Instance details

Defined in Stripe.Resources

ToJSON Product 
Instance details

Defined in Stripe.Resources

FromJSON Product 
Instance details

Defined in Stripe.Resources

data Price #

Instances

Instances details
Eq Price 
Instance details

Defined in Stripe.Resources

Methods

(==) :: Price -> Price -> Bool #

(/=) :: Price -> Price -> Bool #

Show Price 
Instance details

Defined in Stripe.Resources

Methods

showsPrec :: Int -> Price -> ShowS #

show :: Price -> String #

showList :: [Price] -> ShowS #

ToJSON Price 
Instance details

Defined in Stripe.Resources

FromJSON Price 
Instance details

Defined in Stripe.Resources

data ProductCreate #

Constructors

ProductCreate 

Instances

Instances details
Eq ProductCreate 
Instance details

Defined in Stripe.Resources

Show ProductCreate 
Instance details

Defined in Stripe.Resources

Generic ProductCreate 
Instance details

Defined in Stripe.Resources

Associated Types

type Rep ProductCreate :: Type -> Type #

ToForm ProductCreate 
Instance details

Defined in Stripe.Resources

Methods

toForm :: ProductCreate -> Form #

type Rep ProductCreate 
Instance details

Defined in Stripe.Resources

type Rep ProductCreate = D1 ('MetaData "ProductCreate" "Stripe.Resources" "stripe-servant-0.3.0.0-BDZ8cVxXkVLAWAtVr94due" 'False) (C1 ('MetaCons "ProductCreate" 'PrefixI 'True) (S1 ('MetaSel ('Just "prcName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "prcDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

data PriceCreate #

Instances

Instances details
Eq PriceCreate 
Instance details

Defined in Stripe.Resources

Show PriceCreate 
Instance details

Defined in Stripe.Resources

Generic PriceCreate 
Instance details

Defined in Stripe.Resources

Associated Types

type Rep PriceCreate :: Type -> Type #

ToForm PriceCreate 
Instance details

Defined in Stripe.Resources

Methods

toForm :: PriceCreate -> Form #

type Rep PriceCreate 
Instance details

Defined in Stripe.Resources

Subscriptions

data SubscriptionCreate #

Instances

Instances details
Eq SubscriptionCreate 
Instance details

Defined in Stripe.Resources

Show SubscriptionCreate 
Instance details

Defined in Stripe.Resources

Generic SubscriptionCreate 
Instance details

Defined in Stripe.Resources

Associated Types

type Rep SubscriptionCreate :: Type -> Type #

ToForm SubscriptionCreate 
Instance details

Defined in Stripe.Resources

type Rep SubscriptionCreate 
Instance details

Defined in Stripe.Resources

type Rep SubscriptionCreate = D1 ('MetaData "SubscriptionCreate" "Stripe.Resources" "stripe-servant-0.3.0.0-BDZ8cVxXkVLAWAtVr94due" 'False) (C1 ('MetaCons "SubscriptionCreate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "scCustomer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CustomerId) :*: S1 ('MetaSel ('Just "scItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SubscriptionCreateItem])) :*: (S1 ('MetaSel ('Just "scCancelAtPeriodEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "scTrialEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeStamp)))))

data SubscriptionCreateItem #

Instances

Instances details
Eq SubscriptionCreateItem 
Instance details

Defined in Stripe.Resources

Show SubscriptionCreateItem 
Instance details

Defined in Stripe.Resources

Generic SubscriptionCreateItem 
Instance details

Defined in Stripe.Resources

Associated Types

type Rep SubscriptionCreateItem :: Type -> Type #

type Rep SubscriptionCreateItem 
Instance details

Defined in Stripe.Resources

type Rep SubscriptionCreateItem = D1 ('MetaData "SubscriptionCreateItem" "Stripe.Resources" "stripe-servant-0.3.0.0-BDZ8cVxXkVLAWAtVr94due" 'False) (C1 ('MetaCons "SubscriptionCreateItem" 'PrefixI 'True) (S1 ('MetaSel ('Just "sciPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PriceId) :*: S1 ('MetaSel ('Just "sciQuantity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

Customer Portal

data CustomerPortalCreate #

Instances

Instances details
Eq CustomerPortalCreate 
Instance details

Defined in Stripe.Resources

Show CustomerPortalCreate 
Instance details

Defined in Stripe.Resources

Generic CustomerPortalCreate 
Instance details

Defined in Stripe.Resources

Associated Types

type Rep CustomerPortalCreate :: Type -> Type #

ToForm CustomerPortalCreate 
Instance details

Defined in Stripe.Resources

type Rep CustomerPortalCreate 
Instance details

Defined in Stripe.Resources

type Rep CustomerPortalCreate = D1 ('MetaData "CustomerPortalCreate" "Stripe.Resources" "stripe-servant-0.3.0.0-BDZ8cVxXkVLAWAtVr94due" 'False) (C1 ('MetaCons "CustomerPortalCreate" 'PrefixI 'True) (S1 ('MetaSel ('Just "cpcCustomer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CustomerId) :*: S1 ('MetaSel ('Just "cpcReturnUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

Checkout

data CheckoutSessionCreate #

Instances

Instances details
Eq CheckoutSessionCreate 
Instance details

Defined in Stripe.Resources

Show CheckoutSessionCreate 
Instance details

Defined in Stripe.Resources

Generic CheckoutSessionCreate 
Instance details

Defined in Stripe.Resources

Associated Types

type Rep CheckoutSessionCreate :: Type -> Type #

ToForm CheckoutSessionCreate 
Instance details

Defined in Stripe.Resources

type Rep CheckoutSessionCreate 
Instance details

Defined in Stripe.Resources

type Rep CheckoutSessionCreate = D1 ('MetaData "CheckoutSessionCreate" "Stripe.Resources" "stripe-servant-0.3.0.0-BDZ8cVxXkVLAWAtVr94due" 'False) (C1 ('MetaCons "CheckoutSessionCreate" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cscCancelUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "cscMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "cscPaymentMethodTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "cscSuccessUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "cscClientReferenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cscCustomer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomerId))) :*: (S1 ('MetaSel ('Just "cscAllowPromotionCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cscLineItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CheckoutSessionCreateLineItem])))))

data CheckoutSessionCreateLineItem #

Events

newtype EventId #

Constructors

EventId 

Fields

Instances

Instances details
Eq EventId 
Instance details

Defined in Stripe.Resources

Methods

(==) :: EventId -> EventId -> Bool #

(/=) :: EventId -> EventId -> Bool #

Show EventId 
Instance details

Defined in Stripe.Resources

ToJSON EventId 
Instance details

Defined in Stripe.Resources

FromJSON EventId 
Instance details

Defined in Stripe.Resources

ToHttpApiData EventId 
Instance details

Defined in Stripe.Resources

data Event #

Constructors

Event 

Instances

Instances details
Eq Event 
Instance details

Defined in Stripe.Resources

Methods

(==) :: Event -> Event -> Bool #

(/=) :: Event -> Event -> Bool #

Show Event 
Instance details

Defined in Stripe.Resources

Methods

showsPrec :: Int -> Event -> ShowS #

show :: Event -> String #

showList :: [Event] -> ShowS #

ToJSON Event 
Instance details

Defined in Stripe.Resources

FromJSON Event 
Instance details

Defined in Stripe.Resources

data EventData #

Constructors

EventData 

Fields

Instances

Instances details
Eq EventData 
Instance details

Defined in Stripe.Resources

Show EventData 
Instance details

Defined in Stripe.Resources

ToJSON EventData 
Instance details

Defined in Stripe.Resources

FromJSON EventData 
Instance details

Defined in Stripe.Resources