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

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

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

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

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

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

Eq TokenId

Defined in Stripe.Concepts

Methods

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

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

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

Eq CustomerId

Defined in Stripe.Concepts

Methods

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

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

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

Eq ProductId

Defined in Stripe.Concepts

Methods

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

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

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

Eq PlanId

Defined in Stripe.Concepts

Methods

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

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

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

Eq SubscriptionId

Defined in Stripe.Concepts

Methods

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

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

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

Eq InvoiceId

Defined in Stripe.Concepts

Methods

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

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

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

Eq CouponId

Defined in Stripe.Concepts

Methods

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

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

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

Eq ApiVersion

Defined in Stripe.Concepts

Methods

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

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

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

Eq RequestApiVersion

Defined in Stripe.Concepts

Methods

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

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