Skip to content

Commit

Permalink
add shared options to documentation (beam-community#452)
Browse files Browse the repository at this point in the history
  • Loading branch information
dnsbty authored and jalexander committed Nov 18, 2024
1 parent 42e0c99 commit f7010c0
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions lib/stripe.ex
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,19 @@ defmodule Stripe do
config :stripity_stripe, api_key: System.get_env("STRIPE_API_KEY")
### Shared Options
Almost all of the requests that can be sent accept the following options:
* `:api_key` - The Stripe API key to use for the request. See
[https://stripe.com/docs/api/authentication](https://stripe.com/docs/api/authentication)
* `:connect_account` - The ID of a Stripe Connect account for which the
request should be made, passed through as the "Stripe-Account" header. The
preferred authentication method for Stripe Connect. See
[https://stripe.com/docs/connect/authentication#stripe-account-header](https://stripe.com/docs/connect/authentication#stripe-account-header)
* `:expand` - Takes a list of fields that should be expanded in the response
from Stripe. See [https://stripe.com/docs/api/expanding_objects](https://stripe.com/docs/api/expanding_objects)
### HTTP Connection Pool
Stripity Stripe is set up to use an HTTP connection pool by default. This
Expand Down

0 comments on commit f7010c0

Please sign in to comment.