# Stripe for Elixir [![Build Status](]( [![](]( [![Hex Docs](]( [![](]( [![Inline docs](]( [![Coverage Status](](

An Elixir library for working with [Stripe](


* facilitate using the Connect API (for standalone/managed accounts)
[Stripe Connect]( by allowing you to supply your
own key. The oauth callback processor (not endpoint) is supplied by this library
as well as a connect button url generator. See below for
[Stripe Connect API reference](

## Stripe API

This library is built on Stripe API version 2016-07-06.
[The docs are up at Hex](

## Usage

Install the dependency:

{:stripity_stripe, "~> 2.0.0"}

Next, add to your applications:

defp application do
  [applications: [:stripity_stripe]]

## Configuration

To make API calls, it is necessary to configure your Stripe secret key (and
optional platform client id if you are using Stripe Connect):

use Mix.Config

config :stripity_stripe, secret_key: "YOUR SECRET KEY"
config :stripity_stripe, platform_client_id: "YOUR CONNECT PLATFORM CLIENT ID"

To customize the underlying HTTPoison library, you may optionally add an
`:httpoison_options` key to the stripity_stripe configuration.  For a full list
of configuration options, please refer to the
[HTTPoison documentation](

config :stripity_stripe, httpoison_options: [
  timeout: 10000,
  recv_timeout: 10000,
  proxy: {"", 8080}

## Testing

All tests have the @tag disabled: false and the test runner is configured to
ignore disabled: true. This helps to turn tests on/off when working in them.

mix test

## The API

The API attempts to model the official Ruby library as closely as makes sense
while adhering to Elixir syntax and principles.

{:ok, object} = Stripe.Customer.delete "cus_8Pq6iJMrd4M0AD"

For optional arguments, you can send in a Keyword list that will get translated
to parameters. So if you want to update a Subscription, for instance, you must
send in the `customer_id` and `subscription_id` with the list of changes:

# Change customer to the Premium subscription
{:ok, customer} = Stripe.Customer.update %{email: ""}

Metadata (metadata: %{}) key is supported on most object type and allow the
storage of extra information on the stripe platform.

API calls will always return either `{:ok, _record}` or `{:error, error}`.
Errors will be maps directly mirroring
[the Stripe API Error response object](

Pagination is available on list calls and follows
[the Stripe API Pagination docs](

# Example of paging through events
{:ok, events} = Stripe.Customer.list(%{limit: 10})

# Connect

Stripe Connect allows you to provide your customers with an easy onboarding to
their own Stripe account. This is useful when you run an e-commerce as a service
platform. Each merchant can transact using their own account using your
platform. Then your platform uses Stripe's API with their own API key obtained
in the onboarding process.

First, you need to register your platform on Stripe Connect to obtain a
`client_id`. In your account settings, there's a "Connect" tab, select it. Then
fill the information to activate your connect platform settings. Then select the
`client_id` (notice there's one for dev and one for prod), stash this
`client_id` in the config file under

config :stripity_stripe, platform_client_id: "ac_???"
or in an env var named `STRIPE_PLATFORM_CLIENT_ID`.

Then you send your users to sign up for the stripe account using a link.

Here's an example of a button to start the workflow:
<a href="">Connect with Stripe</a>

You can generate this URL using:

url = Stripe.Connect.generate_button_url(%{state: "csrf_token"})

When the user gets back to your platform, the following url (`redirect_uri` form
item on your "Connect" settings) will be used:




Using the code request parameter, you make the following call:

{:ok, resp} -> Stripe.Connect.oauth_token_callback(code)

## Contributing

Feedback, feature requests, and fixes are welcomed and encouraged.  Please make
appropriate use of [Issues](
and [Pull Requests](  All
code should have accompanying tests.

## License

Please see [LICENSE](LICENSE) for licensing details.