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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._refund import Refund
from stripe._request_options import RequestOptions
from stripe.params._refund_cancel_params import RefundCancelParams
from stripe.params._refund_create_params import RefundCreateParams
from stripe.params._refund_list_params import RefundListParams
from stripe.params._refund_retrieve_params import RefundRetrieveParams
from stripe.params._refund_update_params import RefundUpdateParams
class RefundService(StripeService):
def list(
self,
params: Optional["RefundListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Refund]":
"""
Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
"""
return cast(
"ListObject[Refund]",
self._request(
"get",
"/v1/refunds",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["RefundListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Refund]":
"""
Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
"""
return cast(
"ListObject[Refund]",
await self._request_async(
"get",
"/v1/refunds",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["RefundCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Refund":
"""
When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Creating a new refund will refund a charge that has previously been created but not yet refunded.
Funds will be refunded to the credit or debit card that was originally charged.
You can optionally refund only part of a charge.
You can do so multiple times, until the entire charge has been refunded.
Once entirely refunded, a charge can't be refunded again.
This method will raise an error when called on an already-refunded charge,
or when trying to refund more money than is left on a charge.
"""
return cast(
"Refund",
self._request(
"post",
"/v1/refunds",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["RefundCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Refund":
"""
When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Creating a new refund will refund a charge that has previously been created but not yet refunded.
Funds will be refunded to the credit or debit card that was originally charged.
You can optionally refund only part of a charge.
You can do so multiple times, until the entire charge has been refunded.
Once entirely refunded, a charge can't be refunded again.
This method will raise an error when called on an already-refunded charge,
or when trying to refund more money than is left on a charge.
"""
return cast(
"Refund",
await self._request_async(
"post",
"/v1/refunds",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
refund: str,
params: Optional["RefundRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Refund":
"""
Retrieves the details of an existing refund.
"""
return cast(
"Refund",
self._request(
"get",
"/v1/refunds/{refund}".format(refund=sanitize_id(refund)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
refund: str,
params: Optional["RefundRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Refund":
"""
Retrieves the details of an existing refund.
"""
return cast(
"Refund",
await self._request_async(
"get",
"/v1/refunds/{refund}".format(refund=sanitize_id(refund)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
refund: str,
params: Optional["RefundUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Refund":
"""
Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
This request only accepts metadata as an argument.
"""
return cast(
"Refund",
self._request(
"post",
"/v1/refunds/{refund}".format(refund=sanitize_id(refund)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
refund: str,
params: Optional["RefundUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Refund":
"""
Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
This request only accepts metadata as an argument.
"""
return cast(
"Refund",
await self._request_async(
"post",
"/v1/refunds/{refund}".format(refund=sanitize_id(refund)),
base_address="api",
params=params,
options=options,
),
)
def cancel(
self,
refund: str,
params: Optional["RefundCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Refund":
"""
Cancels a refund with a status of requires_action.
You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
"""
return cast(
"Refund",
self._request(
"post",
"/v1/refunds/{refund}/cancel".format(
refund=sanitize_id(refund),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_async(
self,
refund: str,
params: Optional["RefundCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Refund":
"""
Cancels a refund with a status of requires_action.
You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
"""
return cast(
"Refund",
await self._request_async(
"post",
"/v1/refunds/{refund}/cancel".format(
refund=sanitize_id(refund),
),
base_address="api",
params=params,
options=options,
),
)
|
