diff --git a/README.md b/README.md index 47d2191137..5adfcd7f5a 100644 --- a/README.md +++ b/README.md @@ -467,14 +467,15 @@ stripe.customers This is a convenience for cases where you expect the number of items to be relatively small; accordingly, you must pass a `limit` option -to prevent runaway list growth from consuming too much memory. +to prevent runaway list growth from consuming too much memory. Once the +`limit` number of items have been fetched, auto-pagination will stop. Returns a promise of an array of all items across pages for a list request. ```js const allNewCustomers = await stripe.customers - .list({created: {gt: lastMonth}}) - .autoPagingToArray({limit: 10000}); + .list({created: {gt: lastMonth}, limit: 100}) // 100 items per page + .autoPagingToArray({limit: 10000}); // Stop after 10000 items total ``` ### Telemetry