stripity-stripe

# Stripe for Elixir

An Elixir library for working with [Stripe](https://stripe.com/).

[![Hex.pm](https://img.shields.io/hexpm/v/stripity_stripe.svg?maxAge=2592000)](https://hex.pm/packages/stripity_stripe) [![Hex.pm](https://img.shields.io/hexpm/dt/stripity_stripe.svg?maxAge=2592000)](https://hex.pm/packages/stripity_stripe)

## 2.x.x status

[![Hex Docs](https://img.shields.io/badge/hex-docs-9768d1.svg)](https://hexdocs.pm/stripity_stripe) [![Inline docs](https://inch-ci.org/github/beam-community/stripity_stripe.svg?branch=main)](https://inch-ci.org/github/beam-community/stripity_stripe?branch=main) [![Coverage Status](https://coveralls.io/repos/github/beam-community/stripity_stripe/badge.svg?branch=main)](https://coveralls.io/github/beam-community/stripity_stripe?branch=main)

# Which version should I use?

Below is a list of which Stripe API version recent releases of Stripe Elixir. It only indicates the API version being called, not necessarily its compatibility. See the [Stripe API Upgrades page](https://stripe.com/docs/upgrades) for more details.

Starting with stripity_stripe version 2.5.0, you can specify the Stripe API Version to use for a specific request by including the `:api_version` option. Note that while this will use a specific Stripe API Version to make the request, the library will still expect a response matching its corresponding default Stripe API Version. See the [Shared Options documentation](https://hexdocs.pm/stripity_stripe/2.17.2/Stripe.html#module-shared-options) for more details.

| `:stripity_stripe` | Stripe API Version |
| ------------------ | ------------------ |
| `2.0.x`            | `2018-02-28`       |
| `2.1.0 - 2.2.0`    | `2018-05-21`       |
| `2.2.2`            | `2018-08-23`       |
| `2.2.3 - 2.3.0`    | `2018-11-08`       |
| `2.4.0 - 2.7.0`    | `2019-05-16`       |
| `master`           | `2019-10-17`       |

# Documentation

- [Latest HexDocs](https://hexdocs.pm/stripity_stripe/)

## Installation

Install the dependency by version:

```elixir
{:stripity_stripe, "~> 3.3"}
```

Or by commit reference:

```elixir
{:stripity_stripe, git: "https://github.com/beam-community/stripity_stripe", ref: "017d7ecdb5aeadccc03986c02396791079178ba2"}
```

Next, add to your applications:

_Not necessary if using elixir >= 1.4_

```elixir
defp application do
  [applications: [:stripity_stripe]]
end
```

## Configuration

To make API calls, it is necessary to configure your Stripe secret key.

```elixir
import Config

config :stripity_stripe, api_key: System.get_env("STRIPE_SECRET")
# OR
config :stripity_stripe, api_key: "YOUR SECRET KEY"
```

It's possible to use a function or a tuple to resolve the secret:

```elixir
config :stripity_stripe, api_key: {MyApp.Secrets, :stripe_secret, []}
# OR
config :stripity_stripe, api_key: fn -> System.get_env("STRIPE_SECRET") end
```

Moreover, if you are using Poison instead of Jason, you can configure the library to use Poison like so:

```elixir
config :stripity_stripe, json_