1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._payment_method import PaymentMethod
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class CustomerPaymentMethodService(StripeService):
class ListParams(TypedDict):
allow_redisplay: NotRequired[
Literal["always", "limited", "unspecified"]
]
"""
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
"""
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
type: NotRequired[
Literal[
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"card",
"cashapp",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"swish",
"twint",
"us_bank_account",
"wechat_pay",
"zip",
]
]
"""
An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
def list(
self,
customer: str,
params: "CustomerPaymentMethodService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[PaymentMethod]:
"""
Returns a list of PaymentMethods for a given Customer
"""
return cast(
ListObject[PaymentMethod],
self._request(
"get",
"/v1/customers/{customer}/payment_methods".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
customer: str,
params: "CustomerPaymentMethodService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[PaymentMethod]:
"""
Returns a list of PaymentMethods for a given Customer
"""
return cast(
ListObject[PaymentMethod],
await self._request_async(
"get",
"/v1/customers/{customer}/payment_methods".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
customer: str,
payment_method: str,
params: "CustomerPaymentMethodService.RetrieveParams" = {},
options: RequestOptions = {},
) -> PaymentMethod:
"""
Retrieves a PaymentMethod object for a given Customer.
"""
return cast(
PaymentMethod,
self._request(
"get",
"/v1/customers/{customer}/payment_methods/{payment_method}".format(
customer=sanitize_id(customer),
payment_method=sanitize_id(payment_method),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
customer: str,
payment_method: str,
params: "CustomerPaymentMethodService.RetrieveParams" = {},
options: RequestOptions = {},
) -> PaymentMethod:
"""
Retrieves a PaymentMethod object for a given Customer.
"""
return cast(
PaymentMethod,
await self._request_async(
"get",
"/v1/customers/{customer}/payment_methods/{payment_method}".format(
customer=sanitize_id(customer),
payment_method=sanitize_id(payment_method),
),
base_address="api",
params=params,
options=options,
),
)
|
