GET requests with arrays in data not handled correctly by stripe API

[richie3366]

I noticed (and found a workaround to solve) a bug occurring in GET requests with data containing arrays.

For example: stripe.invoices.retrieve('upcoming', {..., subscription_items: [..., ...] })

This will try to make a GET request with url-encoded data (in the body of the request apparently(?)), but the converted querystring doesn't** have array indexes.
**: purposely, according to the commit found via blame ; and also according to the 'Stripe-specific cases' test in utils.spec.js)

Thing is: Stripe API seems to need them to understand the query.

Current code in utils.js:

  /**
   * Stringifies an Object, accommodating nested objects
   * (forming the conventional key 'parent[child]=value')
   */
  stringifyRequestData: function(data) {
    // console.log('stringifyRequestData', data, qs.stringify(data, {arrayFormat: 'brackets'}))
    return qs.stringify(data, {arrayFormat: 'brackets'});
  },

outputs:

subscription=sub_ES6MM9DZExqcN0&subscription_prorate=true&subscription_items%5B%5D%5Bid%5D=si_ES6MwymN93s0Fh&subscription_items%5B%5D%5Bdeleted%5D=true&subscription_items%5B%5D%5Bplan%5D=business_monthly&subscription_items%5B%5D%5Bquantity%5D=1&coupon=redacted

urldecoded:

subscription=sub_ES6MM9DZExqcN0&subscription_prorate=true&subscription_items[][id]=si_ES6MwymN93s0Fh&subscription_items[][deleted]=true&subscription_items[][plan]=business_monthly&subscription_items[][quantity]=1&coupon=redacted

Log trace in Stripe Dashboard:

With workaround:

  /**
   * Stringifies an Object, accommodating nested objects
   * (forming the conventional key 'parent[child]=value')
   */
  stringifyRequestData: function(data) {
    // console.log('stringifyRequestData', data, qs.stringify(data, {arrayFormat: 'brackets'}))
    return qs.stringify(data);
  },

outputs:

subscription=sub_ES6MM9DZExqcN0&subscription_prorate=true&subscription_items%5B0%5D%5Bid%5D=si_ES6MwymN93s0Fh&subscription_items%5B0%5D%5Bdeleted%5D=true&subscription_items%5B1%5D%5Bplan%5D=business_monthly&subscription_items%5B1%5D%5Bquantity%5D=1&coupon=redacted

urldecoded:

subscription=sub_ES6MM9DZExqcN0&subscription_prorate=true&subscription_items[0][id]=si_ES6MwymN93s0Fh&subscription_items[0][deleted]=true&subscription_items[1][plan]=business_monthly&subscription_items[1][quantity]=1&coupon=redacted

Log trace in Stripe Dashboard:

So, either you have to fix it in your API backend (to accept unindexed array backets), or fix it here (to provide API compatible format).

Thanks.

[remi-stripe]

@richie3366 Thanks a lot for the detailed bug report! This is something that has happened in some of our other libraries such as reported here.

We're going to take a look to ensure we fix it properly on all requests in stripe-node.

[abrisene]

This also appears to happen with POST requests. I discovered while trying to create products with attributes for the first time and encountered range errors.

Converting the array to an integer indexed object (as shown in the workaround posted by @richie3366) fixed the issue.

[remi-stripe]

@abrisene Thanks for the extra details here and sorry for the delay on that one. We are investigating and will try to fix that next week!

[ob-stripe]

This should be fixed in 6.25.1.