Stripe API client for Elixir. Documentation
- Everything except for Relay features are complete and tested.
- Looking for more contributors/maintainers for this project, currently need help with documentation.
- Add
stripeto your list of dependencies inmix.exs:
def deps do
[{:stripe, "~> 0.8.0", hex: :stripe_elixir}]
end- (Pre-Elixir 1.4) Ensure
stripeis started before your application:
def application do
[applications: [:stripe]]
end- Make sure your stripe secret_key is added to your config file:
config :stripe, :secret_key, <YOUR_SECRET_KEY>
- Alternatively, you can also set the secret key as an environment variable:
export STRIPE_SECRET_KEY=<YOUR_SECRET_KEY>This lib closely follows the official Ruby Client API.
Stripe.{RESOURCE}.createStripe.{RESOURCE}.retrieveStripe.{RESOURCE}.updateStripe.{RESOURCE}.list
Returns {:ok, RESPONSE_BODY} when the request is successful.
{:error, %ERROR_STRUCT{}} tuples are returned when there is a request/api error.
See all error types at https://stripe.com/docs/api/ruby#errors
Create a customer:
{:ok, %{"id" => "cus_asdfghjkl"} =
Stripe.Customer.create(email: "[email protected]")
Note that either KeywordLists or Maps with either String or Atom keys are acceptable for arguments and options. So all of the following would also work:
Stripe.Customer.create(%{email: "[email protected]"})
Stripe.Customer.create(%{"email" => "[email protected]"})
Stripe.Customer.create([{"email", "[email protected]"}])Retrieve that customer:
{:ok, customer} = Stripe.Customer.retrieve("cus_asdfghjkl")Update the customer:
{:ok, %{"metadata" => %{"somedata" => "somevalue"}}} =
Stripe.Customer.update("cus_asdfghjkl", metadata: [somedata: "somevalue"])Delete the customer:
{:ok, %{"deleted" => true}} = Stripe.Customer.delete("cus_asdfghjkl")To perform a Direct Charge on a connected stripe account, simply pass :stripe_account as an option
Stripe.Charge.create([customer: "cus_asdfghjkl", amount: 400], stripe_account: "acct_sOMeAcCountId")Stripe.Connect.authorize_url([
redirect_uri: <OPTIONAL CALLBACK URL>,
state: <OPTIONAL CSRF TOKEN>,
client_id: <OPTIONAL STRIPE PLATFORM CLIENT ID>
])redirect_uri: An optional callback url after authorization succeeds.state: You can protect your request from CSRF attacks by passing a csrf token.client_id: You can pass in an optional client_id to be used for this url. Defaults toSTRIPE_CLIENT_IDenvironment variable orconfig :stripe, :client_idconfig value.
Stripe uses webhooks to notify your web app with events. Stripe.Webhook provides construct_event/3 to authenticate the requests, which can be useful in plugs.
payload = # HTTP content body (e.g. from Plug.Conn.read_body/3)
signature = # 'Stripe-Signature' HTTP header (e.g. from Plug.Conn.get_req_header/2)
secret = # Provided by Stripe
case Stripe.Webhook.construct_event(payload, signature, secret) do
{:ok, event} ->
# Return 2XX
{:error, %Stripe.SignatureVerificationError{}} ->
# Return non-2XX and handle error
end
The default tolerance is 5 minutes (300 seconds as per official libraries). If your app is rejecting requests because the tolerance is too low, consider passing a higher number to construct_event/4.
Stripe.Webhook.construct_event(payload, signature, secret, 600)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent