Stripe Clojure

https://github.com/yonureker/stripe-clojure
Admin
A Clojure library providing convenient access to the Stripe API, allowing developers to integrate...
Tokens:2,645
Snippets:17
Trust Score:8.6
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installing and Managing Stripe-Mock with Homebrew (Bash)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This snippet provides Bash commands for installing and managing `stripe-mock` using Homebrew. It covers installation, starting the service, upgrading, and restarting, which are essential steps for setting up a local Stripe API mock server required for testing.

```Bash
brew install stripe/stripe-mock/stripe-mock

# start a stripe-mock service at login
brew services start stripe-mock

# upgrade if you already have it
brew upgrade stripe-mock

# restart the service after upgrading
brew services restart stripe-mock
```

--------------------------------

### Stripe API Call Examples with Parameters and Options in Clojure

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This snippet provides various examples of making Stripe API calls, demonstrating how to pass parameters, options (like `max-network-retries` and `idempotency-key`), and how to retrieve or list resources using the initialized Stripe client.

```Clojure
;; passing params and opts
(customers/create-customer stripe-client {:name "Onur" :email "yonureker@gmail.com"} 
                                           {:max-network-retries 5 :idempotency-key "key_1234"})

;; passing id and opts
(payment-intents/retrieve-payment-intent stripe-client "pi_1234" {:max-network-retries 5})

;; passing id only
(customers/retrieve-customer stripe-client "pi_1234")

;; passing opts only
(customers/list-customers stripe-client {} {:auto-paginate? true})
```

--------------------------------

### Initializing Stripe Client and Creating a Customer in Clojure

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This example illustrates how to initialize a reusable Stripe client instance with an API key and then use it to create a new customer. It shows the necessary `ns` statement for requiring `stripe-clojure.core` and `stripe-clojure.customers`.

```Clojure
;; In your ns statement:
(ns my.ns
  (:require [stripe-clojure.core :as stripe]
            [stripe-clojure.customers :as customers]))

;; client instance has to be initialized once
;; it is reusable
(def stripe-client (stripe/init-stripe {:api-key <your-api-key>}))

;; Create a customer with name and email
(customers/create-customer stripe-client {:name "Onur Eker"
                                          :email "yonureker@gmail.com}) 
```

--------------------------------

### Referencing Stripe Client from Another Namespace in Clojure

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This example shows how to reuse an already initialized Stripe client instance by referencing it from a different namespace. It demonstrates importing the `stripe-client` definition using `:refer` in the `ns` statement.

```Clojure
(ns my.other.ns
  ;; import previously creeated client instance
  (:require [my.ns :refer [stripe-client]]
            [stripe-clojure.customers :as customers]))

(customers/retrieve-customer stripe-client "cus_12345")
```

--------------------------------

### Installing Stripe Clojure Library with deps.edn

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This snippet demonstrates how to include the Stripe Clojure library as a dependency in a `deps.edn` file. It uses the `:mvn/version` key to specify the library's Maven coordinates.

```Clojure
io.github.yonureker/stripe-clojure {:mvn/version "0.3.0"}
```

--------------------------------

### Installing Stripe Clojure Library with Leiningen/Boot

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This snippet shows how to add the Stripe Clojure library as a dependency in a Leiningen or Boot project by modifying the `project.clj` file. It specifies the library's group ID, artifact ID, and version.

```Clojure
[io.github.yonureker/stripe-clojure "0.3.0"]
```

--------------------------------

### Configuring Connection Pooling for Stripe Client (Clojure)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This example shows how to enable and configure HTTP connection pooling for the `stripe-clojure` client. By setting `:use-connection-pool? true` and providing `:pool-options` with parameters like `:timeout`, `:threads`, and `:default-per-route`, you can optimize HTTP connection management for improved performance.

```Clojure
(def stripe-client (stripe/init-stripe {:api-key "your_stripe_api_key"
                                          :use-connection-pool? true
                                          :pool-options {:timeout 5
                                                         :threads 4
                                                         :default-per-route 2
                                                         :insecure? false}}))
```

--------------------------------

### Handling Stripe Client Request and Response Events (Clojure)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

Provides an example of how to initialize the Stripe Clojure client and attach event handler functions for `request` and `response` events. These handlers allow for custom logic, such as logging or debugging, to be executed at different stages of the API call lifecycle. It also shows how to remove an event handler.

```Clojure
(ns your-namespace
  (:require [stripe-clojure.core :as stripe]))

;; Initialize the Stripe client
(def stripe-client (stripe/init-stripe {:api-key "sk_test_..."}))

;; Define an event handler function for requests
(defn on-request [request]
  ;; Do something with the request
  (println "Request event:" request))

;; Add the event handler function
(stripe/on stripe-client :request on-request)

;; Remove the event handler function
(stripe/off stripe-client :request on-request)
```

--------------------------------

### Initializing Stripe Client Instance in Clojure

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This snippet demonstrates how to initialize a Stripe client instance in Clojure using `stripe-clojure.core/init-stripe`. It shows a comprehensive configuration map including API key, API version, network retries, timeout, rate limits, connection pooling, and response formatting options. This configuration allows fine-grained control over the client's behavior and interaction with the Stripe API.

```Clojure
(ns my.ns
  (:require [stripe-clojure.core :as stripe])

(def stripe-instance (stripe/init-stripe {:api-key "test_key_123"
                                          :api-version "2020-05-28"
                                          :max-network-retries 3
                                          :timeout 2000
                                          :rate-limits {:live {:default {:read 5 :write 5}
                                                               :search {:read 10 :write 0}}
                                                        :test {:default {:read 20 :write 20}}}
                                          :use-connection-pool? true
                                          :pool-options {:timeout 5
                                                         :threads 4
                                                         :default-per-route 2
                                                         :insecure? false}
                                          :full-response? true
                                          :kebabify-keys? true}))
```

--------------------------------

### Running Stripe Clojure Tests with CLI Tools (Bash)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This Bash command shows how to execute the `stripe-clojure` test suite using the Clojure CLI tools. It assumes `stripe-mock` is running and the `STRIPE_TEST_API_KEY` environment variable is set, allowing for comprehensive testing of the library's functionality.

```Bash
clj -M:test
```

--------------------------------

### Managing Multiple Stripe Client Instances in Clojure

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This snippet illustrates how to initialize and use multiple independent Stripe client instances, each with potentially different API keys or configurations (e.g., `max-network-retries`). It also shows how to shut down a client instance to release resources.

```Clojure
(ns my.other-other.ns
  (:require [stripe-clojure.core :as stripe]
            [stripe-clojure.customers :as customers]))

;; Initializing
(def us-client (stripe/init-stripe {:api-key <us-api-key>}))
(def eu-client (stripe/init-stripe {:api-key <eu-api-key>}))
(def no-retry-client (stripe/init-stripe {:api-key <some-api-key>
                                          :max-network-retries 0}))

;; Using with requests
(customers/retrieve-customer us-client "cus_123445")
(customers/list-customers eu-client {:limit 10})
(customers/create-customer no-retry-client {:name "onur"
                                            :email "yonureker@gmail.com"})

;; They can be shutdown, releasing any internal and pooled resources.
(stripe/shutdown-stripe-client! eu-client)
```

--------------------------------

### Default Stripe Test API Key Configuration (Clojure)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This Clojure snippet from `src/stripe_clojure/config.clj` defines how the test API key is loaded. It attempts to retrieve the key from the `STRIPE_TEST_API_KEY` environment variable, falling back to a default `"test_api_key"` if the environment variable is not set.

```Clojure
(def api-keys
  {:test (or (System/getenv "STRIPE_TEST_API_KEY") "test_api_key")})
```

--------------------------------

### Auto-Paginating Stripe List and Search Endpoints (Clojure)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This snippet demonstrates how to enable auto-pagination for Stripe list and search endpoints in Clojure. By setting `:auto-paginate? true`, the library automatically fetches all pages of results as a lazy sequence, allowing for efficient processing of large datasets with a configurable `:limit` per API call.

```Clojure
(ns my.project
  (:require [stripe-clojure.core :as stripe]
            [stripe-clojure.customers :as customers]))

(def stripe-client (stripe/init-stripe {:api-key "your_stripe_api_key"}))

;; Auto-paginate through a list endpoint with a per-page limit.
(def all-customers
  (customers/list-customers stripe-client {:limit 50} {:auto-paginate? true}))

;; Auto-paginate through a search endpoint using Stripe Search Query Language.
;; https://docs.stripe.com/search#search-query-language
(def search-query "email:'sally@rocketrides.io'")
(def matching-customers
  (customers/search-customers stripe-client {:query search-query :limit 50} {:auto-paginate? true}))

;; Process and print list results lazily.
(println "List Customers:")
(doseq [customer all-customers]
  (println (:id customer)))

;; Process and print search results lazily.
(println "Search Customers:")
(doseq [customer matching-customers]
  (println (:id customer)))
```

--------------------------------

### Expanding Customer Object in Payment Intent Retrieval (Clojure)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

Illustrates how to use the `:expand` option to automatically retrieve the full customer object when fetching a Payment Intent. By passing `{:expand ["customer"]}` in the options map, the `:customer` key in the response will contain the complete customer details instead of just the ID.

```Clojure
(def pi-with-customer-info (payment-intents/retrieve-payment-intent 
                                stripe-instance 
                                "pi_1234" 
                                {:expand ["customer"]}))

;; response now has the customer object
{:description "payment for order"
 :id "pi_1234"
 ...
 :customer {:name "onur" :email "yonureker@gmail.com" ...} ;; now we have the customer object
 :payment_method "pm_1234"
 }
```

--------------------------------

### Setting Stripe Test API Key Environment Variable (Bash)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

This Bash command demonstrates how to set the `STRIPE_TEST_API_KEY` environment variable. This variable is used by the `stripe-clojure` test suite to authenticate against the Stripe API, allowing users to run tests with their own test API keys.

```Bash
export STRIPE_TEST_API_KEY='sk_test_1234567890abcdef'
```

--------------------------------

### Expanding Multiple Objects in Payment Intent Retrieval (Clojure)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

Demonstrates expanding multiple linked objects, such as both `:customer` and `:payment_method`, in a single Payment Intent retrieval. The `:expand` option accepts a vector of strings, allowing multiple related objects to be included directly in the response, reducing subsequent API calls.

```Clojure
(def pi-with-customer-info (payment-intents/retrieve-payment-intent 
                                stripe-instance 
                                "pi_1234" 
                                {:expand ["customer" "payment_method"]}))

;; both customer and payment_method is expanded
{:description "payment for order"
 :id "pi_1234"
 ...
 :customer {:name "onur" :email "yonureker@gmail.com" ...}
 :payment_method {:type "card" :last4 "4242" ...}
 }
```

--------------------------------

### Retrieving Payment Intent without Expansion (Clojure)

Source: https://github.com/yonureker/stripe-clojure/blob/master/README.md

Demonstrates how to retrieve a Stripe Payment Intent using the `payment-intents/retrieve-payment-intent` function. By default, linked objects such as `:customer` are returned as their IDs, requiring additional API calls to fetch their full details.

```Clojure
(def pi-retrieved (payment-intents/retrieve-payment-intent stripe-instance "pi_1234"))

;; payment intent response
{:description "payment for order"
 :id "pi_1234"
 ...
 :customer "cus_1234" ;; only customer id returned
 :payment-method "pm_1234"
 }
```
Tokens:
Raw