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
|
# -*- 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 PaymentIntentIncrementAuthorizationParams(RequestOptions):
amount: int
"""
The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.
"""
amount_details: NotRequired[
"PaymentIntentIncrementAuthorizationParamsAmountDetails"
]
"""
Provides industry-specific information about the amount.
"""
application_fee_amount: NotRequired[int]
"""
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
"""
description: NotRequired[str]
"""
An arbitrary string attached to the object. Often useful for displaying to users.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired[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`.
"""
payment_details: NotRequired[
"PaymentIntentIncrementAuthorizationParamsPaymentDetails"
]
"""
Provides industry-specific information about the charge.
"""
statement_descriptor: NotRequired[str]
"""
Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
"""
transfer_data: NotRequired[
"PaymentIntentIncrementAuthorizationParamsTransferData"
]
"""
The parameters used to automatically create a transfer after the payment is captured.
Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetails(TypedDict):
discount_amount: NotRequired["Literal['']|int"]
"""
The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.
"""
line_items: NotRequired[
"Literal['']|List[PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItem]"
]
"""
A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
"""
shipping: NotRequired[
"Literal['']|PaymentIntentIncrementAuthorizationParamsAmountDetailsShipping"
]
"""
Contains information about the shipping portion of the amount.
"""
tax: NotRequired[
"Literal['']|PaymentIntentIncrementAuthorizationParamsAmountDetailsTax"
]
"""
Contains information about the tax portion of the amount.
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItem(
TypedDict
):
discount_amount: NotRequired[int]
"""
The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
This field is mutually exclusive with the `amount_details[discount_amount]` field.
"""
payment_method_options: NotRequired[
"PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptions"
]
"""
Payment method-specific information for line items.
"""
product_code: NotRequired[str]
"""
The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long.
"""
product_name: str
"""
The product name of the line item. Required for L3 rates. At most 1024 characters long.
For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters.
"""
quantity: int
"""
The quantity of items. Required for L3 rates. An integer greater than 0.
"""
tax: NotRequired[
"PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemTax"
]
"""
Contains information about the tax on the item.
"""
unit_cost: int
"""
The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
"""
unit_of_measure: NotRequired[str]
"""
A unit of measure for the line item, such as gallons, feet, meters, etc.
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptions(
TypedDict,
):
card: NotRequired[
"PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptionsCard"
]
"""
This sub-hash contains line item details that are specific to `card` payment method."
"""
card_present: NotRequired[
"PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptionsCardPresent"
]
"""
This sub-hash contains line item details that are specific to `card_present` payment method."
"""
klarna: NotRequired[
"PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptionsKlarna"
]
"""
This sub-hash contains line item details that are specific to `klarna` payment method."
"""
paypal: NotRequired[
"PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptionsPaypal"
]
"""
This sub-hash contains line item details that are specific to `paypal` payment method."
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptionsCard(
TypedDict,
):
commodity_code: NotRequired[str]
"""
Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptionsCardPresent(
TypedDict,
):
commodity_code: NotRequired[str]
"""
Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptionsKlarna(
TypedDict,
):
image_url: NotRequired[str]
"""
URL to an image for the product. Max length, 4096 characters.
"""
product_url: NotRequired[str]
"""
URL to the product page. Max length, 4096 characters.
"""
reference: NotRequired[str]
"""
Unique reference for this line item to correlate it with your system's internal records. The field is displayed in the Klarna Consumer App if passed.
"""
subscription_reference: NotRequired[str]
"""
Reference for the subscription this line item is for.
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemPaymentMethodOptionsPaypal(
TypedDict,
):
category: NotRequired[
Literal["digital_goods", "donation", "physical_goods"]
]
"""
Type of the line item.
"""
description: NotRequired[str]
"""
Description of the line item.
"""
sold_by: NotRequired[str]
"""
The Stripe account ID of the connected account that sells the item.
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsLineItemTax(
TypedDict,
):
total_tax_amount: int
"""
The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field.
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsShipping(
TypedDict
):
amount: NotRequired["Literal['']|int"]
"""
If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0.
"""
from_postal_code: NotRequired["Literal['']|str"]
"""
If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed.
"""
to_postal_code: NotRequired["Literal['']|str"]
"""
If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed.
"""
class PaymentIntentIncrementAuthorizationParamsAmountDetailsTax(TypedDict):
total_tax_amount: int
"""
The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.
This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.
"""
class PaymentIntentIncrementAuthorizationParamsPaymentDetails(TypedDict):
customer_reference: NotRequired["Literal['']|str"]
"""
A unique value to identify the customer. This field is available only for card payments.
This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
"""
order_reference: NotRequired["Literal['']|str"]
"""
A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`.
For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
"""
class PaymentIntentIncrementAuthorizationParamsTransferData(TypedDict):
amount: NotRequired[int]
"""
The amount that will be transferred automatically when a charge succeeds.
"""
|
