README.md in stripe-3.13.0 vs README.md in stripe-3.13.1
- old
+ new
@@ -78,18 +78,24 @@
``` ruby
require "stripe"
Stripe::Charge.list(
{},
- :api_key => "sk_test_...",
- :stripe_account => "acct_..."
+ {
+ :api_key => "sk_test_...",
+ :stripe_account => "acct_...",
+ :stripe_version => "2018-02-28"
+ }
)
Stripe::Charge.retrieve(
"ch_18atAXCdGbJFKhCuBAa4532Z",
- :api_key => "sk_test_...",
- :stripe_account => "acct_..."
+ {
+ :api_key => "sk_test_...",
+ :stripe_account => "acct_...",
+ :stripe_version => "2018-02-28"
+ }
)
```
### Configuring a Client
@@ -106,10 +112,19 @@
)
end
puts resp.request_id
```
+### Configuration an API Version
+
+By default, the library will use the API version pinned to the account making
+a request. This can be overridden with this global option:
+
+ Stripe.api_version = "2018-02-28"
+
+See [versioning in the API reference][versioning] for more information.
+
### Configuring CA Bundles
By default, the library will use its own internal bundle of known CA
certificates, but it's possible to configure your own:
@@ -202,9 +217,10 @@
[connect]: https://stripe.com/connect
[curl]: http://curl.haxx.se/docs/caextract.html
[faraday]: https://github.com/lostisland/faraday
[idempotency-keys]: https://stripe.com/docs/api/ruby#idempotent_requests
[stripe-mock]: https://github.com/stripe/stripe-mock
+[versioning]: https://stripe.com/docs/api/ruby#versioning
<!--
# vim: set tw=79:
-->