Stripe.Concepts

Modes

data Mode

"To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no switch for changing between modes, just use the appropriate key to perform a live or test transaction. Requests made with test mode credentials never hit the banking networks and incur no cost." - Stripe

This library provides functions to convert back and forth between Mode and Bool:

• isLiveMode (and its inverse, isLiveMode')
• isTestMode (and its inverse, isTestMode')

Constructors

LiveMode

TestMode

Instances

Data Mode

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Mode -> c Mode

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Mode

toConstr :: Mode -> Constr

dataTypeOf :: Mode -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Mode)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Mode)

gmapT :: (forall b. Data b => b -> b) -> Mode -> Mode

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Mode -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Mode -> r

gmapQ :: (forall d. Data d => d -> u) -> Mode -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Mode -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Mode -> m Mode

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Mode -> m Mode

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Mode -> m Mode

Bounded Mode

Defined in Stripe.Concepts

Methods

minBound :: Mode

maxBound :: Mode

Enum Mode

Defined in Stripe.Concepts

Methods

succ :: Mode -> Mode

pred :: Mode -> Mode

toEnum :: Int -> Mode

fromEnum :: Mode -> Int

enumFrom :: Mode -> [Mode]

enumFromThen :: Mode -> Mode -> [Mode]

enumFromTo :: Mode -> Mode -> [Mode]

enumFromThenTo :: Mode -> Mode -> Mode -> [Mode]

Generic Mode

Defined in Stripe.Concepts

Associated Types

type Rep Mode :: Type -> Type

Methods

from :: Mode -> Rep Mode x

to :: Rep Mode x -> Mode

Show Mode

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> Mode -> ShowS

show :: Mode -> String

showList :: [Mode] -> ShowS

Eq Mode

Defined in Stripe.Concepts

Methods

(==) :: Mode -> Mode -> Bool

(/=) :: Mode -> Mode -> Bool

Ord Mode

Defined in Stripe.Concepts

Methods

compare :: Mode -> Mode -> Ordering

(<) :: Mode -> Mode -> Bool

(<=) :: Mode -> Mode -> Bool

(>) :: Mode -> Mode -> Bool

(>=) :: Mode -> Mode -> Bool

max :: Mode -> Mode -> Mode

min :: Mode -> Mode -> Mode

type Rep Mode

Defined in Stripe.Concepts

type Rep Mode = D1 ('MetaData "Mode" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'False) (C1 ('MetaCons "LiveMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TestMode" 'PrefixI 'False) (U1 :: Type -> Type))

data BothModes a

A pair of values of the same type, one for live mode and one for test mode.

For example, you may wish to use a value of type BothModes PublishableApiKey to represent your publishable API keys for both live mode and test mode.

Constructors

BothModes

Fields

• liveMode :: a
• testMode :: a

Instances

Functor BothModes

Defined in Stripe.Concepts

Methods

fmap :: (a -> b) -> BothModes a -> BothModes b

(<$) :: a -> BothModes b -> BothModes a

Data a => Data (BothModes a)

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BothModes a -> c (BothModes a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (BothModes a)

toConstr :: BothModes a -> Constr

dataTypeOf :: BothModes a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (BothModes a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (BothModes a))

gmapT :: (forall b. Data b => b -> b) -> BothModes a -> BothModes a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BothModes a -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BothModes a -> r

gmapQ :: (forall d. Data d => d -> u) -> BothModes a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> BothModes a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BothModes a -> m (BothModes a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BothModes a -> m (BothModes a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BothModes a -> m (BothModes a)

Generic (BothModes a)

Defined in Stripe.Concepts

Associated Types

type Rep (BothModes a) :: Type -> Type

Methods

from :: BothModes a -> Rep (BothModes a) x

to :: Rep (BothModes a) x -> BothModes a

Show a => Show (BothModes a)

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> BothModes a -> ShowS

show :: BothModes a -> String

showList :: [BothModes a] -> ShowS

Eq a => Eq (BothModes a)

Defined in Stripe.Concepts

Methods

(==) :: BothModes a -> BothModes a -> Bool

(/=) :: BothModes a -> BothModes a -> Bool

type Rep (BothModes a)

Defined in Stripe.Concepts

type Rep (BothModes a) = D1 ('MetaData "BothModes" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'False) (C1 ('MetaCons "BothModes" 'PrefixI 'True) (S1 ('MetaSel ('Just "liveMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "testMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

applyMode :: Mode -> BothModes a -> a

Conversion with Bool

isLiveMode :: Mode -> Bool

LiveMode → True; TestMode → False

isTestMode :: Mode -> Bool

LiveMode → False; TestMode → True

isLiveMode' :: Bool -> Mode

True → LiveMode; False → TestMode

isTestMode' :: Bool -> Mode

True → TestMode; False → LiveMode

Keys

Each Stripe account has a pair of API keys involved in making requests to the Stripe API:

• The publishable key (PublishableApiKey)
• The secret key (ApiSecretKey)

Each webhook endpoint you set up has a "signing secret" (WebhookSecretKey) that you use to verify the authenticity of the webhook events you receive *from* Stripe.

newtype PublishableApiKey

Publishable API keys are used in client-side code.

"Publishable API keys are meant solely to identify your account with Stripe, they aren’t secret. In other words, they can safely be published in places like your Stripe.js JavaScript code, or in an Android or iPhone app. Publishable keys only have the power to create tokens." - Stripe

Constructors

PublishableApiKey Text

Instances

Data PublishableApiKey

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PublishableApiKey -> c PublishableApiKey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PublishableApiKey

toConstr :: PublishableApiKey -> Constr

dataTypeOf :: PublishableApiKey -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PublishableApiKey)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PublishableApiKey)

gmapT :: (forall b. Data b => b -> b) -> PublishableApiKey -> PublishableApiKey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PublishableApiKey -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PublishableApiKey -> r

gmapQ :: (forall d. Data d => d -> u) -> PublishableApiKey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PublishableApiKey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PublishableApiKey -> m PublishableApiKey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PublishableApiKey -> m PublishableApiKey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PublishableApiKey -> m PublishableApiKey

Generic PublishableApiKey

Defined in Stripe.Concepts

Associated Types

type Rep PublishableApiKey :: Type -> Type

Methods

from :: PublishableApiKey -> Rep PublishableApiKey x

to :: Rep PublishableApiKey x -> PublishableApiKey

Show PublishableApiKey

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> PublishableApiKey -> ShowS

show :: PublishableApiKey -> String

showList :: [PublishableApiKey] -> ShowS

Eq PublishableApiKey

Defined in Stripe.Concepts

Methods

(==) :: PublishableApiKey -> PublishableApiKey -> Bool

(/=) :: PublishableApiKey -> PublishableApiKey -> Bool

Ord PublishableApiKey

Defined in Stripe.Concepts

Methods

compare :: PublishableApiKey -> PublishableApiKey -> Ordering

(<) :: PublishableApiKey -> PublishableApiKey -> Bool

(<=) :: PublishableApiKey -> PublishableApiKey -> Bool

(>) :: PublishableApiKey -> PublishableApiKey -> Bool

(>=) :: PublishableApiKey -> PublishableApiKey -> Bool

max :: PublishableApiKey -> PublishableApiKey -> PublishableApiKey

min :: PublishableApiKey -> PublishableApiKey -> PublishableApiKey

type Rep PublishableApiKey

Defined in Stripe.Concepts

type Rep PublishableApiKey = D1 ('MetaData "PublishableApiKey" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "PublishableApiKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Secret API key

newtype ApiSecretKey

API secret keys are used to make requests to Stripe.

"Authenticate your account when using the API by including your secret API key in the request. You can manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secret!" - Stripe

The key is represented here as a ByteString, but you are likely have the data as a Text value. You can use textToApiSecretKey to do this conversion.

Constructors

ApiSecretKey ByteString

Instances

Eq ApiSecretKey

Defined in Stripe.Concepts

Methods

(==) :: ApiSecretKey -> ApiSecretKey -> Bool

(/=) :: ApiSecretKey -> ApiSecretKey -> Bool

Ord ApiSecretKey

Defined in Stripe.Concepts

Methods

compare :: ApiSecretKey -> ApiSecretKey -> Ordering

(<) :: ApiSecretKey -> ApiSecretKey -> Bool

(<=) :: ApiSecretKey -> ApiSecretKey -> Bool

(>) :: ApiSecretKey -> ApiSecretKey -> Bool

(>=) :: ApiSecretKey -> ApiSecretKey -> Bool

max :: ApiSecretKey -> ApiSecretKey -> ApiSecretKey

min :: ApiSecretKey -> ApiSecretKey -> ApiSecretKey

textToApiSecretKey :: Text -> ApiSecretKey

Convert a Text representation of a Stripe API key (that looks something like "sk_test_BQokikJOvBiI2HlWgH4olfQ2") to an ApiSecretKey.

Webhook secret

newtype WebhookSecretKey

Webhook secrets are used to verify the authenticity of webhook events that you receive from Stripe.

"Stripe can optionally sign the webhook events it sends to your endpoints. We do so by including a signature in each event’s Stripe-Signature header. This allows you to validate that the events were sent by Stripe, not by a third party. [...] Before you can verify signatures, you need to retrieve your endpoint’s secret from your Dashboard’s Webhooks settings. - Stripe

The key is represented here as a ByteString, but you are likely have the data as a Text value. You can use textToWebhookSecretKey to do this conversion.

Constructors

WebhookSecretKey ByteString

Instances

Eq WebhookSecretKey

Defined in Stripe.Concepts

Methods

(==) :: WebhookSecretKey -> WebhookSecretKey -> Bool

(/=) :: WebhookSecretKey -> WebhookSecretKey -> Bool

Ord WebhookSecretKey

Defined in Stripe.Concepts

Methods

compare :: WebhookSecretKey -> WebhookSecretKey -> Ordering

(<) :: WebhookSecretKey -> WebhookSecretKey -> Bool

(<=) :: WebhookSecretKey -> WebhookSecretKey -> Bool

(>) :: WebhookSecretKey -> WebhookSecretKey -> Bool

(>=) :: WebhookSecretKey -> WebhookSecretKey -> Bool

max :: WebhookSecretKey -> WebhookSecretKey -> WebhookSecretKey

min :: WebhookSecretKey -> WebhookSecretKey -> WebhookSecretKey

textToWebhookSecretKey :: Text -> WebhookSecretKey

Convert a Text representation of a Stripe webhook secret (that looks something like "whsec_ojm5cmJMGMTw3w7ngjI7mgkRsFGLRtCt") to a WebhookSecretKey.

Identifiers

newtype TokenId

Identifier of a Stripe "token", which represents a payment source that was submitted by a user to Stripe.

"This ensures that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way." - Stripe

Constructors

TokenId Text

Instances

Data TokenId

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TokenId -> c TokenId

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TokenId

toConstr :: TokenId -> Constr

dataTypeOf :: TokenId -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TokenId)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TokenId)

gmapT :: (forall b. Data b => b -> b) -> TokenId -> TokenId

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TokenId -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TokenId -> r

gmapQ :: (forall d. Data d => d -> u) -> TokenId -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TokenId -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TokenId -> m TokenId

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenId -> m TokenId

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenId -> m TokenId

Generic TokenId

Defined in Stripe.Concepts

Associated Types

type Rep TokenId :: Type -> Type

Methods

from :: TokenId -> Rep TokenId x

to :: Rep TokenId x -> TokenId

Show TokenId

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> TokenId -> ShowS

show :: TokenId -> String

showList :: [TokenId] -> ShowS

Eq TokenId

Defined in Stripe.Concepts

Methods

(==) :: TokenId -> TokenId -> Bool

(/=) :: TokenId -> TokenId -> Bool

Ord TokenId

Defined in Stripe.Concepts

Methods

compare :: TokenId -> TokenId -> Ordering

(<) :: TokenId -> TokenId -> Bool

(<=) :: TokenId -> TokenId -> Bool

(>) :: TokenId -> TokenId -> Bool

(>=) :: TokenId -> TokenId -> Bool

max :: TokenId -> TokenId -> TokenId

min :: TokenId -> TokenId -> TokenId

type Rep TokenId

Defined in Stripe.Concepts

type Rep TokenId = D1 ('MetaData "TokenId" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "TokenId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype CustomerId

A customer identifier assigned by Stripe.

"Customer objects allow you to perform recurring charges, and to track multiple charges, that are associated with the same customer." - Stripe

Constructors

CustomerId Text

Instances

Data CustomerId

Defined in Stripe.Concepts

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 :: forall r r'. (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

Generic CustomerId

Defined in Stripe.Concepts

Associated Types

type Rep CustomerId :: Type -> Type

Methods

from :: CustomerId -> Rep CustomerId x

to :: Rep CustomerId x -> CustomerId

Show CustomerId

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> CustomerId -> ShowS

show :: CustomerId -> String

showList :: [CustomerId] -> ShowS

Eq CustomerId

Defined in Stripe.Concepts

Methods

(==) :: CustomerId -> CustomerId -> Bool

(/=) :: CustomerId -> CustomerId -> Bool

Ord CustomerId

Defined in Stripe.Concepts

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

type Rep CustomerId

Defined in Stripe.Concepts

type Rep CustomerId = D1 ('MetaData "CustomerId" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "CustomerId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype ProductId

The ID of a Stripe product.

"Product objects describe items that your customers can subscribe to with a Subscription. An associated Plan determines the product pricing." - Stripe

Constructors

ProductId Text

Instances

Data ProductId

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProductId -> c ProductId

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProductId

toConstr :: ProductId -> Constr

dataTypeOf :: ProductId -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProductId)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProductId)

gmapT :: (forall b. Data b => b -> b) -> ProductId -> ProductId

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProductId -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProductId -> r

gmapQ :: (forall d. Data d => d -> u) -> ProductId -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProductId -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProductId -> m ProductId

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProductId -> m ProductId

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProductId -> m ProductId

Generic ProductId

Defined in Stripe.Concepts

Associated Types

type Rep ProductId :: Type -> Type

Methods

from :: ProductId -> Rep ProductId x

to :: Rep ProductId x -> ProductId

Show ProductId

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> ProductId -> ShowS

show :: ProductId -> String

showList :: [ProductId] -> ShowS

Eq ProductId

Defined in Stripe.Concepts

Methods

(==) :: ProductId -> ProductId -> Bool

(/=) :: ProductId -> ProductId -> Bool

Ord ProductId

Defined in Stripe.Concepts

Methods

compare :: ProductId -> ProductId -> Ordering

(<) :: ProductId -> ProductId -> Bool

(<=) :: ProductId -> ProductId -> Bool

(>) :: ProductId -> ProductId -> Bool

(>=) :: ProductId -> ProductId -> Bool

max :: ProductId -> ProductId -> ProductId

min :: ProductId -> ProductId -> ProductId

type Rep ProductId

Defined in Stripe.Concepts

type Rep ProductId = D1 ('MetaData "ProductId" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "ProductId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype PlanId

The ID of a Stripe subscription plan.

"Plans define the base price, currency, and billing cycle for subscriptions. For example, you might have a $5/month plan that provides limited access to your products, and a $15/month plan that allows full access." - Stripe

Constructors

PlanId Text

Instances

Data PlanId

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PlanId -> c PlanId

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PlanId

toConstr :: PlanId -> Constr

dataTypeOf :: PlanId -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PlanId)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PlanId)

gmapT :: (forall b. Data b => b -> b) -> PlanId -> PlanId

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PlanId -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PlanId -> r

gmapQ :: (forall d. Data d => d -> u) -> PlanId -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PlanId -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PlanId -> m PlanId

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PlanId -> m PlanId

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PlanId -> m PlanId

Generic PlanId

Defined in Stripe.Concepts

Associated Types

type Rep PlanId :: Type -> Type

Methods

from :: PlanId -> Rep PlanId x

to :: Rep PlanId x -> PlanId

Show PlanId

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> PlanId -> ShowS

show :: PlanId -> String

showList :: [PlanId] -> ShowS

Eq PlanId

Defined in Stripe.Concepts

Methods

(==) :: PlanId -> PlanId -> Bool

(/=) :: PlanId -> PlanId -> Bool

Ord PlanId

Defined in Stripe.Concepts

Methods

compare :: PlanId -> PlanId -> Ordering

(<) :: PlanId -> PlanId -> Bool

(<=) :: PlanId -> PlanId -> Bool

(>) :: PlanId -> PlanId -> Bool

(>=) :: PlanId -> PlanId -> Bool

max :: PlanId -> PlanId -> PlanId

min :: PlanId -> PlanId -> PlanId

type Rep PlanId

Defined in Stripe.Concepts

type Rep PlanId = D1 ('MetaData "PlanId" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "PlanId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype SubscriptionId

Identifier for a customer's subscription to a product.

"Subscriptions allow you to charge a customer on a recurring basis. A subscription ties a customer to a particular plan you've created." - Stripe

Constructors

SubscriptionId Text

Instances

Data SubscriptionId

Defined in Stripe.Concepts

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 :: forall r r'. (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

Generic SubscriptionId

Defined in Stripe.Concepts

Associated Types

type Rep SubscriptionId :: Type -> Type

Methods

from :: SubscriptionId -> Rep SubscriptionId x

to :: Rep SubscriptionId x -> SubscriptionId

Show SubscriptionId

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> SubscriptionId -> ShowS

show :: SubscriptionId -> String

showList :: [SubscriptionId] -> ShowS

Eq SubscriptionId

Defined in Stripe.Concepts

Methods

(==) :: SubscriptionId -> SubscriptionId -> Bool

(/=) :: SubscriptionId -> SubscriptionId -> Bool

Ord SubscriptionId

Defined in Stripe.Concepts

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

type Rep SubscriptionId

Defined in Stripe.Concepts

type Rep SubscriptionId = D1 ('MetaData "SubscriptionId" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "SubscriptionId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype InvoiceId

The ID of a Stripe invoice.

"Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription." - Stripe

Constructors

InvoiceId Text

Instances

Data InvoiceId

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InvoiceId -> c InvoiceId

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InvoiceId

toConstr :: InvoiceId -> Constr

dataTypeOf :: InvoiceId -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c InvoiceId)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InvoiceId)

gmapT :: (forall b. Data b => b -> b) -> InvoiceId -> InvoiceId

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InvoiceId -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InvoiceId -> r

gmapQ :: (forall d. Data d => d -> u) -> InvoiceId -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InvoiceId -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InvoiceId -> m InvoiceId

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InvoiceId -> m InvoiceId

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InvoiceId -> m InvoiceId

Generic InvoiceId

Defined in Stripe.Concepts

Associated Types

type Rep InvoiceId :: Type -> Type

Methods

from :: InvoiceId -> Rep InvoiceId x

to :: Rep InvoiceId x -> InvoiceId

Show InvoiceId

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> InvoiceId -> ShowS

show :: InvoiceId -> String

showList :: [InvoiceId] -> ShowS

Eq InvoiceId

Defined in Stripe.Concepts

Methods

(==) :: InvoiceId -> InvoiceId -> Bool

(/=) :: InvoiceId -> InvoiceId -> Bool

Ord InvoiceId

Defined in Stripe.Concepts

Methods

compare :: InvoiceId -> InvoiceId -> Ordering

(<) :: InvoiceId -> InvoiceId -> Bool

(<=) :: InvoiceId -> InvoiceId -> Bool

(>) :: InvoiceId -> InvoiceId -> Bool

(>=) :: InvoiceId -> InvoiceId -> Bool

max :: InvoiceId -> InvoiceId -> InvoiceId

min :: InvoiceId -> InvoiceId -> InvoiceId

type Rep InvoiceId

Defined in Stripe.Concepts

type Rep InvoiceId = D1 ('MetaData "InvoiceId" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "InvoiceId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype CouponId

The ID of a Stripe coupon.

"A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to invoices or orders." - Stripe

Constructors

CouponId Text

Instances

Data CouponId

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CouponId -> c CouponId

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CouponId

toConstr :: CouponId -> Constr

dataTypeOf :: CouponId -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CouponId)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CouponId)

gmapT :: (forall b. Data b => b -> b) -> CouponId -> CouponId

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CouponId -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CouponId -> r

gmapQ :: (forall d. Data d => d -> u) -> CouponId -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CouponId -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CouponId -> m CouponId

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CouponId -> m CouponId

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CouponId -> m CouponId

Generic CouponId

Defined in Stripe.Concepts

Associated Types

type Rep CouponId :: Type -> Type

Methods

from :: CouponId -> Rep CouponId x

to :: Rep CouponId x -> CouponId

Show CouponId

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> CouponId -> ShowS

show :: CouponId -> String

showList :: [CouponId] -> ShowS

Eq CouponId

Defined in Stripe.Concepts

Methods

(==) :: CouponId -> CouponId -> Bool

(/=) :: CouponId -> CouponId -> Bool

Ord CouponId

Defined in Stripe.Concepts

Methods

compare :: CouponId -> CouponId -> Ordering

(<) :: CouponId -> CouponId -> Bool

(<=) :: CouponId -> CouponId -> Bool

(>) :: CouponId -> CouponId -> Bool

(>=) :: CouponId -> CouponId -> Bool

max :: CouponId -> CouponId -> CouponId

min :: CouponId -> CouponId -> CouponId

type Rep CouponId

Defined in Stripe.Concepts

type Rep CouponId = D1 ('MetaData "CouponId" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "CouponId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

API Versioning

newtype ApiVersion

When Stripe makes a backwards-incompatible change to the API, they release a new API version. The versions are named by the date of their release (e.g. "2019-09-09").

Constructors

ApiVersion Text

Instances

Data ApiVersion

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ApiVersion -> c ApiVersion

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ApiVersion

toConstr :: ApiVersion -> Constr

dataTypeOf :: ApiVersion -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ApiVersion)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ApiVersion)

gmapT :: (forall b. Data b => b -> b) -> ApiVersion -> ApiVersion

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ApiVersion -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ApiVersion -> r

gmapQ :: (forall d. Data d => d -> u) -> ApiVersion -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ApiVersion -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ApiVersion -> m ApiVersion

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ApiVersion -> m ApiVersion

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ApiVersion -> m ApiVersion

Generic ApiVersion

Defined in Stripe.Concepts

Associated Types

type Rep ApiVersion :: Type -> Type

Methods

from :: ApiVersion -> Rep ApiVersion x

to :: Rep ApiVersion x -> ApiVersion

Show ApiVersion

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> ApiVersion -> ShowS

show :: ApiVersion -> String

showList :: [ApiVersion] -> ShowS

Eq ApiVersion

Defined in Stripe.Concepts

Methods

(==) :: ApiVersion -> ApiVersion -> Bool

(/=) :: ApiVersion -> ApiVersion -> Bool

Ord ApiVersion

Defined in Stripe.Concepts

Methods

compare :: ApiVersion -> ApiVersion -> Ordering

(<) :: ApiVersion -> ApiVersion -> Bool

(<=) :: ApiVersion -> ApiVersion -> Bool

(>) :: ApiVersion -> ApiVersion -> Bool

(>=) :: ApiVersion -> ApiVersion -> Bool

max :: ApiVersion -> ApiVersion -> ApiVersion

min :: ApiVersion -> ApiVersion -> ApiVersion

type Rep ApiVersion

Defined in Stripe.Concepts

type Rep ApiVersion = D1 ('MetaData "ApiVersion" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'True) (C1 ('MetaCons "ApiVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data RequestApiVersion

Your account API settings specify:

• Which API version is used by default for requests;
• Which API version is used for webhook events.

However, you can override the API version for specific requests. "To set the API version on a specific request, send a Stripe-Version header." - Stripe

Constructors

DefaultApiVersion

Use the default API version specified by your account settings.

OverrideApiVersion ApiVersion

Use a specific API version for this request. (Please note however that any webhook events generated as a result of this request will still use your account's default API version.)

Instances

Data RequestApiVersion

Defined in Stripe.Concepts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RequestApiVersion -> c RequestApiVersion

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RequestApiVersion

toConstr :: RequestApiVersion -> Constr

dataTypeOf :: RequestApiVersion -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RequestApiVersion)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RequestApiVersion)

gmapT :: (forall b. Data b => b -> b) -> RequestApiVersion -> RequestApiVersion

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RequestApiVersion -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RequestApiVersion -> r

gmapQ :: (forall d. Data d => d -> u) -> RequestApiVersion -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RequestApiVersion -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RequestApiVersion -> m RequestApiVersion

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestApiVersion -> m RequestApiVersion

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestApiVersion -> m RequestApiVersion

Generic RequestApiVersion

Defined in Stripe.Concepts

Associated Types

type Rep RequestApiVersion :: Type -> Type

Methods

from :: RequestApiVersion -> Rep RequestApiVersion x

to :: Rep RequestApiVersion x -> RequestApiVersion

Show RequestApiVersion

Defined in Stripe.Concepts

Methods

showsPrec :: Int -> RequestApiVersion -> ShowS

show :: RequestApiVersion -> String

showList :: [RequestApiVersion] -> ShowS

Eq RequestApiVersion

Defined in Stripe.Concepts

Methods

(==) :: RequestApiVersion -> RequestApiVersion -> Bool

(/=) :: RequestApiVersion -> RequestApiVersion -> Bool

Ord RequestApiVersion

Defined in Stripe.Concepts

Methods

compare :: RequestApiVersion -> RequestApiVersion -> Ordering

(<) :: RequestApiVersion -> RequestApiVersion -> Bool

(<=) :: RequestApiVersion -> RequestApiVersion -> Bool

(>) :: RequestApiVersion -> RequestApiVersion -> Bool

(>=) :: RequestApiVersion -> RequestApiVersion -> Bool

max :: RequestApiVersion -> RequestApiVersion -> RequestApiVersion

min :: RequestApiVersion -> RequestApiVersion -> RequestApiVersion

type Rep RequestApiVersion

Defined in Stripe.Concepts

type Rep RequestApiVersion = D1 ('MetaData "RequestApiVersion" "Stripe.Concepts" "stripe-concepts-1.0.3.3-J89sDiwWUM3J6hhvvzyVOC" 'False) (C1 ('MetaCons "DefaultApiVersion" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OverrideApiVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ApiVersion)))