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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from typing import Dict, List
from typing_extensions import Literal, NotRequired, TypedDict
class DisputeModifyParams(RequestOptions):
amount: NotRequired[int]
"""
The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
evidence: NotRequired["DisputeModifyParamsEvidence"]
"""
Evidence provided for the dispute.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired["Literal['']|Dict[str, str]"]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
class DisputeModifyParamsEvidence(TypedDict):
canceled: NotRequired["Literal['']|DisputeModifyParamsEvidenceCanceled"]
"""
Evidence provided when `reason` is 'canceled'.
"""
duplicate: NotRequired["Literal['']|DisputeModifyParamsEvidenceDuplicate"]
"""
Evidence provided when `reason` is 'duplicate'.
"""
fraudulent: NotRequired[
"Literal['']|DisputeModifyParamsEvidenceFraudulent"
]
"""
Evidence provided when `reason` is 'fraudulent'.
"""
merchandise_not_as_described: NotRequired[
"Literal['']|DisputeModifyParamsEvidenceMerchandiseNotAsDescribed"
]
"""
Evidence provided when `reason` is 'merchandise_not_as_described'.
"""
no_valid_authorization: NotRequired[
"Literal['']|DisputeModifyParamsEvidenceNoValidAuthorization"
]
"""
Evidence provided when `reason` is 'no_valid_authorization'.
"""
not_received: NotRequired[
"Literal['']|DisputeModifyParamsEvidenceNotReceived"
]
"""
Evidence provided when `reason` is 'not_received'.
"""
other: NotRequired["Literal['']|DisputeModifyParamsEvidenceOther"]
"""
Evidence provided when `reason` is 'other'.
"""
reason: NotRequired[
Literal[
"canceled",
"duplicate",
"fraudulent",
"merchandise_not_as_described",
"no_valid_authorization",
"not_received",
"other",
"service_not_as_described",
]
]
"""
The reason for filing the dispute. The evidence should be submitted in the field of the same name.
"""
service_not_as_described: NotRequired[
"Literal['']|DisputeModifyParamsEvidenceServiceNotAsDescribed"
]
"""
Evidence provided when `reason` is 'service_not_as_described'.
"""
class DisputeModifyParamsEvidenceCanceled(TypedDict):
additional_documentation: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
"""
canceled_at: NotRequired["Literal['']|int"]
"""
Date when order was canceled.
"""
cancellation_policy_provided: NotRequired["Literal['']|bool"]
"""
Whether the cardholder was provided with a cancellation policy.
"""
cancellation_reason: NotRequired["Literal['']|str"]
"""
Reason for canceling the order.
"""
expected_at: NotRequired["Literal['']|int"]
"""
Date when the cardholder expected to receive the product.
"""
explanation: NotRequired["Literal['']|str"]
"""
Explanation of why the cardholder is disputing this transaction.
"""
product_description: NotRequired["Literal['']|str"]
"""
Description of the merchandise or service that was purchased.
"""
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
"""
Whether the product was a merchandise or service.
"""
return_status: NotRequired[
"Literal['']|Literal['merchant_rejected', 'successful']"
]
"""
Result of cardholder's attempt to return the product.
"""
returned_at: NotRequired["Literal['']|int"]
"""
Date when the product was returned or attempted to be returned.
"""
class DisputeModifyParamsEvidenceDuplicate(TypedDict):
additional_documentation: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
"""
card_statement: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
"""
cash_receipt: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
"""
check_image: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
"""
explanation: NotRequired["Literal['']|str"]
"""
Explanation of why the cardholder is disputing this transaction.
"""
original_transaction: NotRequired[str]
"""
Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
"""
class DisputeModifyParamsEvidenceFraudulent(TypedDict):
additional_documentation: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
"""
explanation: NotRequired["Literal['']|str"]
"""
Explanation of why the cardholder is disputing this transaction.
"""
class DisputeModifyParamsEvidenceMerchandiseNotAsDescribed(TypedDict):
additional_documentation: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
"""
explanation: NotRequired["Literal['']|str"]
"""
Explanation of why the cardholder is disputing this transaction.
"""
received_at: NotRequired["Literal['']|int"]
"""
Date when the product was received.
"""
return_description: NotRequired["Literal['']|str"]
"""
Description of the cardholder's attempt to return the product.
"""
return_status: NotRequired[
"Literal['']|Literal['merchant_rejected', 'successful']"
]
"""
Result of cardholder's attempt to return the product.
"""
returned_at: NotRequired["Literal['']|int"]
"""
Date when the product was returned or attempted to be returned.
"""
class DisputeModifyParamsEvidenceNoValidAuthorization(TypedDict):
additional_documentation: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
"""
explanation: NotRequired["Literal['']|str"]
"""
Explanation of why the cardholder is disputing this transaction.
"""
class DisputeModifyParamsEvidenceNotReceived(TypedDict):
additional_documentation: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
"""
expected_at: NotRequired["Literal['']|int"]
"""
Date when the cardholder expected to receive the product.
"""
explanation: NotRequired["Literal['']|str"]
"""
Explanation of why the cardholder is disputing this transaction.
"""
product_description: NotRequired["Literal['']|str"]
"""
Description of the merchandise or service that was purchased.
"""
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
"""
Whether the product was a merchandise or service.
"""
class DisputeModifyParamsEvidenceOther(TypedDict):
additional_documentation: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
"""
explanation: NotRequired["Literal['']|str"]
"""
Explanation of why the cardholder is disputing this transaction.
"""
product_description: NotRequired["Literal['']|str"]
"""
Description of the merchandise or service that was purchased.
"""
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
"""
Whether the product was a merchandise or service.
"""
class DisputeModifyParamsEvidenceServiceNotAsDescribed(TypedDict):
additional_documentation: NotRequired["Literal['']|str"]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
"""
canceled_at: NotRequired["Literal['']|int"]
"""
Date when order was canceled.
"""
cancellation_reason: NotRequired["Literal['']|str"]
"""
Reason for canceling the order.
"""
explanation: NotRequired["Literal['']|str"]
"""
Explanation of why the cardholder is disputing this transaction.
"""
received_at: NotRequired["Literal['']|int"]
"""
Date when the product was received.
"""
|
