add shared options to documentation #452
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 similar comment
snewcomer
approved these changes
Jan 17, 2019
lib/stripe.ex
Outdated
| * `:api_key` - The Stripe API key to use for the request. See | ||
| [https://stripe.com/docs/api/authentication](https://stripe.com/docs/api/authentication) | ||
| * `:connect_account` - A Stripe Connect account ID which should originate | ||
| the specified action using the "Stripe-Account" header. The preferred |
There was a problem hiding this comment.
should originate the specified action - any different wording that could be applied here?
There was a problem hiding this comment.
Just updated this. What do you think of the new one?
* `:connect_account` - The ID of a Stripe Connect account for which the
request should be made, passed through as the "Stripe-Account" header. The
preferred authentication method for Stripe Connect. See
[https://stripe.com/docs/connect/authentication#stripe-account-header](https://stripe.com/docs/connect/authentication#stripe-account-header)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to #441 I had a hard time figuring out how to create a charge on a connected account using the
Stripe-Accountheader. Because of that, I submit that documentation around available options should be added. I'd love feedback on exactly where to put that documentation, but I think since it's available in almost every function it should be at a high level.This PR will add a section to the
Stripedocs that looks like this: