Add Ref[T] type for typed v2 object references#1790
Closed
jar-stripe wants to merge 3 commits intomasterfrom
Closed
Add Ref[T] type for typed v2 object references#1790jar-stripe wants to merge 3 commits intomasterfrom
jar-stripe wants to merge 3 commits intomasterfrom
Conversation
Adds a Ref[T] class that represents a typed reference to a Stripe object
with wire shape {type, id, url}. Provides fetch() and fetch_async()
methods that GET the URL and return a strongly-typed T.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Committed-By-Agent: claude
jar-stripe
requested review from
prathmesh-stripe
and removed request for
a team
Ref now stores _requestor and uses requestor.request() for fetch, matching the Event.fetch_related_object pattern. Added _construct_from classmethod so the deserialization pipeline can instantiate Ref with the requestor. Updated _convert_to_stripe_object to handle Ref types. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Committed-By-Agent: claude
xavdid
reviewed
Apr 7, 2026
Member
xavdid
left a comment
xavdid
left a comment
There was a problem hiding this comment.
Similar comments to the other langs
| from stripe._api_requestor import _APIRequestor | ||
| from stripe._stripe_response import StripeResponse | ||
|
|
||
| T = TypeVar("T") |
Member
There was a problem hiding this comment.
This should probably be bound to StripeObject because that's the root of everything that'll go in here.
| def __init__( | ||
| self, | ||
| parsed_body: Dict[str, Any], | ||
| requestor: Optional["_APIRequestor"], |
Member
There was a problem hiding this comment.
same as ruby - in what situations is the Ref useful when the requestor isn't present None?
| T = TypeVar("T") | ||
|
|
||
|
|
||
| class Ref(Generic[T]): |
Member
There was a problem hiding this comment.
Similar to ruby, we probably want this to be a StripeObject?
Contributor
Author
|
Changing direction for now. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
Custom objects need typed references to other Stripe objects. A reference has the wire shape
{type, id, url}and in the SDK becomesRef[T]— a container that knows the target type and can fetch it.What?
stripe.v2.Ref[T]class (Generic[T], not a StripeObject subclass)type,id,url_requestor: Optional[_APIRequestor](not StripeClient)fetch()callsself._requestor.request("get", self.url, base_address="api")— same pattern asEvent.fetch_related_object()fetch_async()for async support_construct_fromclassmethod matchingStripeObject._construct_fromsignature so the deserialization pipeline can instantiate Ref via_inner_class_types_convert_to_stripe_object→_construct_fromautomatically_util.pyforissubclass(klass, Ref)to call Ref's_construct_from(which skipslast_response)See Also
Generated with Claude Code