-
#2642 Update README.md
-
#2645 ⚠️ Remove
stripeMethodand standardize how function args are handled (including removing callback support)- ⚠️ Refactor how incoming method arguments are parsed. Type signatures for API methods should be much more accurate and reliable now
- ⚠️ Remove support for providing callbacks to API methods. Use
async / awaitinstead - ⚠️ Remove support for passing a plain API key as a function arg. If supplied on a per-request basis, it should be in the
RequestOptionsunder theapiKeyproperty - ⚠️ Keys from
paramsandoptionsobjects are no longer mixed. If present on a method,RequestParamsmust always come first andRequestOptionsmust always come second. To supply options without params, passundefinedas the first argument explicitly - ⚠️ Removed methods from
StripeResource:createFullPath,createResourcePathWithSymbols,extend,methodand_joinUrlParts. These were mostly intended for internal use and we no longer need them
- ⚠️ Remove support for providing callbacks to API methods. Use
As a result, the following call patterns are no longer supported:
stripe.customers.retrieve('cus_123', 'sk_test_123') stripe.customers.create({name: 'david', host: 'example.com'}, 'sk_test_123') stripe.customers.create({apiKey: 'sk_test_123'}) stripe.customers.list(customers => { // do something with customers })
If those look familiar, head over to the migration guide to update your code.
- ⚠️ Refactor how incoming method arguments are parsed. Type signatures for API methods should be much more accurate and reliable now
-
#2643 ⚠️ remove support for overriding host per-request
- ⚠️ Removed per-request host override. To use a custom host, set it in the client configuration. All requests from that client will use that host.
Before:
import Stripe from 'stripe'; const stripe = new Stripe('sk_test_...'); const customer = await stripe.customers.create({ email: 'customer@example.com', }, {host: 'example.com'});
After:
import Stripe from 'stripe'; const stripe = new Stripe('sk_test_...', {host: 'example.com'}); // goes to example.com const customer = await stripe.customers.create({ email: 'customer@example.com', });
-
#2619 Improved TypeScript support in the Node SDK
-
#2638 Converted V2/Amount.ts to V2/V2Amount.ts
-
#2635 Updated stripe.spec.ts test and constructEvent.tolerance type