Skip to content

Commit

Permalink
Add additional per-request configuration documentation (#876)
Browse files Browse the repository at this point in the history
  • Loading branch information
joeltaylor authored and ob-stripe committed Nov 1, 2019
1 parent 299e9ea commit 93ea15f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,26 @@ Stripe::Charge.retrieve(
api_key: "sk_test_...",
}
)

Stripe::Charge.capture(
"ch_18atAXCdGbJFKhCuBAa4532Z",
{},
{
stripe_version: "2018-02-28",
api_key: "sk_test_...",
}
)
```

Keep in mind that there are different method signatures depending on the action:
- When operating on a collection (e.g. `.list`, `.create`) the method signature is
`method(params, opts)`.
- When operating on resource (e.g. `.capture`, `.update`) the method signature is
`method(id, params, opts)`.
- One exception is that `retrieve`, despite being an operation on a resource, has the signature
`retrieve(id, opts)`. In addition, it will accept a Hash for the `id` param but will extract the
`id` key out and use the others as options.

### Accessing a response object

Get access to response objects by initializing a client and using its `request`
Expand Down

0 comments on commit 93ea15f

Please sign in to comment.