Update v2 array parameter serialization to use indexed format #1669
+17
−18
Conversation
This file contains hidden or 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
Change array parameter serialization for v2 endpoints to use indexed format (e.g., ?include[0]=foo&include[1]=bar) instead of the repeated parameter format (e.g., ?include=foo&include=bar). This aligns v2 behavior with v1 for consistency. Changes: - Modified _encode.py _api_encode to always use indexed format - Updated tests to expect indexed format for v2 arrays 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> Committed-By-Agent: claude
mbroshi-stripe
commented
Nov 11, 2025
| def _api_encode( | ||
| data, api_mode: Optional[str] | ||
| ) -> Generator[Tuple[str, Any], None, None]: | ||
| def _api_encode(data) -> Generator[Tuple[str, Any], None, None]: |
Contributor
Author
There was a problem hiding this comment.
Is this a breaking change? I'm assuming because it starts with a _ we're OK, but I'm not too sure how we treat that from a semver point of view
Contributor
There was a problem hiding this comment.
in python, an _ prefix conventionally means "private" and most linters will at least complain if someone is trying to access a method prefixed with an _. I think this is not a breaking change here.
mbroshi-stripe
requested review from
jar-stripe
and removed request for
a team
jar-stripe
approved these changes
Nov 11, 2025
| def _api_encode( | ||
| data, api_mode: Optional[str] | ||
| ) -> Generator[Tuple[str, Any], None, None]: | ||
| def _api_encode(data) -> Generator[Tuple[str, Any], None, None]: |
Contributor
There was a problem hiding this comment.
in python, an _ prefix conventionally means "private" and most linters will at least complain if someone is trying to access a method prefixed with an _. I think this is not a breaking change here.
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.
Why?
Stripe has updated how array parameters are handled in
GETandDELETEmethods to/v2endpoints. Previously, the SDKs were serializing them with repeated parameter format (e.g.,?include=foo&include=bar) since that is was the API expected. While that format is still accepted, it is deprecated. Instead, we will serialize array parameters to use indexed format (e.g.,?include[0]=foo&include[1]=bar), which is the preferred method going forward. This aligns v2 behavior with v1 for consistency.What?
stripe/_encode.pyto always use indexed array format for all API modesapi_modeargument to_api_encodefunction and all references to ittests/test_http_client.pyto reflect new behavior