stripity_stripe v2.0.0-alpha.6 Stripe

A HTTP client for Stripe.

Configuration

API Key

You need to set your API key in your application configuration. Typically this is done in config/config.exs or a similar file. For example:

config :stripity_stripe, api_key: "sk_test_abc123456789qwerty"

You can also utilize System.get_env/1 to retrieve the API key from an environment variable, but remember that this can cause issues if you use a release tool like exrm or Distillery.

config :stripity_stripe, api_key: System.get_env("STRIPE_API_KEY")

HTTP Connection Pool

Stripity Stripe is set up to use an HTTP connection pool by default. This means that it will reuse already opened HTTP connections in order to minimize the overhead of establishing connections. The pool is directly supervised by Stripity Stripe. Two configuration options are available to tune how this pool works: :timeout and :max_connections.

:timeout is the amount of time that a connection will be allowed to remain open but idle (no data passing over it) before it is closed and cleaned up. This defaults to 5 seconds.

:max_connections is the maximum number of connections that can be open at any time. This defaults to 10.

Both these settings are located under the :pool_options key in your application configuration:

config :stripity_stripe, :pool_options,
  timeout: 5_000,
  max_connections: 10

If you prefer, you can also turn pooling off completely using the :use_connection_pool setting:

config :stripity_stripe, use_connection_pool: false

Summary

Types

api_error_struct()

body()

headers()

method()

Functions

oauth_request(method, endpoint, body)

A low level utility function to make an OAuth request to the Stripe API

request(body, method, endpoint, headers, opts)

A low level utility function to make a direct request to the Stripe API

request_file_upload(body, method, endpoint, headers, opts)

start(start_type, args)

Callback for the application

Types

api_error_struct()

api_error_struct ::
  %Stripe.APIErrorResponse{code: term, message: term, status_code: term, type: term} |
  %Stripe.APIRateLimitingResponse{message: term} |
  %Stripe.AuthenticationErrorResponse{message: term} |
  %Stripe.HTTPClientFailed{message: term, reason: term} |
  %Stripe.OAuthAPIErrorResponse{error: term, message: term, state: term, status_code: term}

body()

body :: {:multipart, list} | map

headers()

headers :: %{optional(String.t) => String.t} | %{}

method()

method :: :get | :post | :put | :delete | :patch

Functions

oauth_request(method, endpoint, body)

oauth_request(method, String.t, map) ::
  {:ok, map} |
  {:error, api_error_struct}

A low level utility function to make an OAuth request to the Stripe API

request(body, method, endpoint, headers, opts)

request(body, method, String.t, headers, list) ::
  {:ok, map} |
  {:error, api_error_struct}

A low level utility function to make a direct request to the Stripe API

Connect Accounts

If you’d like to make a request on behalf of another Stripe account utilizing the Connect program, you can pass the other Stripe account’s ID to the request function as follows:

request(%{}, :get, "/customers", %{}, connect_account: "acc_134151")

request_file_upload(body, method, endpoint, headers, opts)

request_file_upload(body, method, String.t, headers, list) ::
  {:ok, map} |
  {:error, api_error_struct}

start(start_type, args)

start(Application.start_type, any) ::
  {:error, any} |
  {:ok, pid} |
  {:ok, pid, any}

Callback for the application

Start the supervision tree including the supervised HTTP connection pool (if it’s being used) when the VM loads the application pool.

Note that we are taking advantage of the BEAM application standard in order to start the pool when the application is started. While we do start a supervisor, the supervisor is only to comply with the expectations of the BEAM application standard. It is not given any children to supervise.