Update README.md

Merge pull request #1228 from stripe/richardm-raw-request-readme
Document raw_request
2025-08-13 00:02:50 -04:00 · 2023-05-31 13:41:27 -07:00 · 2023-05-31 13:26:59 -07:00 · 2023-05-31 13:26:20 -07:00 · 2023-05-31 13:25:59 -07:00 · 2023-05-31 13:18:45 -07:00
1 changed files with 11 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -323,6 +323,17 @@ If your beta feature requires a `Stripe-Version` header to be sent, use the `Str
 Stripe.api_version += "; feature_beta=v3"
 ```

+### Custom requests
+
+If you would like to send a request to an undocumented API (for example you are in a private beta), or if you prefer to bypass the method definitions in the library and specify your request details directly, you can use the `raw_request` method on `Stripe`.
+
+```ruby
+resp = Stripe.raw_request(:post, "/v1/beta_endpoint", {param: 123}, {stripe_version: "2022-11-15; feature_beta=v3"})
+
+# (Optional) resp is a StripeResponse. You can use `Stripe.deserialize` to get a StripeObject.
+deserialized_resp = Stripe.deserialize(resp.http_body)
+```
+
 ## Support

 New features and bug fixes are released on the latest major version of the Stripe Ruby library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
Author	SHA1	Message	Date
Richard Marmorstein	a5519a6a57	Update README.md	2023-05-31 13:41:27 -07:00
Richard Marmorstein	90a2a55687	Merge pull request #1228 from stripe/richardm-raw-request-readme Document raw_request	2023-05-31 13:26:59 -07:00
Richard Marmorstein	6e2e8c757d	Update README.md	2023-05-31 13:26:20 -07:00
Richard Marmorstein	c7a26629e6	Update README.md Co-authored-by: pakrym-stripe <99349468+pakrym-stripe@users.noreply.github.com>	2023-05-31 13:25:59 -07:00
Richard Marmorstein	62c0f898c3	Document raw_request	2023-05-31 13:18:45 -07:00