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
|
# -*- 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 SessionModifyParams(RequestOptions):
collected_information: NotRequired[
"SessionModifyParamsCollectedInformation"
]
"""
Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
"""
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`.
"""
shipping_options: NotRequired[
"Literal['']|List[SessionModifyParamsShippingOption]"
]
"""
The shipping rate options to apply to this Session. Up to a maximum of 5.
"""
class SessionModifyParamsCollectedInformation(TypedDict):
shipping_details: NotRequired[
"SessionModifyParamsCollectedInformationShippingDetails"
]
"""
The shipping details to apply to this Session.
"""
class SessionModifyParamsCollectedInformationShippingDetails(TypedDict):
address: "SessionModifyParamsCollectedInformationShippingDetailsAddress"
"""
The address of the customer
"""
name: str
"""
The name of customer
"""
class SessionModifyParamsCollectedInformationShippingDetailsAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: str
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: str
"""
Address line 1, such as the street, PO Box, or company name.
"""
line2: NotRequired[str]
"""
Address line 2, such as the apartment, suite, unit, or building.
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class SessionModifyParamsShippingOption(TypedDict):
shipping_rate: NotRequired[str]
"""
The ID of the Shipping Rate to use for this shipping option.
"""
shipping_rate_data: NotRequired[
"SessionModifyParamsShippingOptionShippingRateData"
]
"""
Parameters to be passed to Shipping Rate creation for this shipping option.
"""
class SessionModifyParamsShippingOptionShippingRateData(TypedDict):
delivery_estimate: NotRequired[
"SessionModifyParamsShippingOptionShippingRateDataDeliveryEstimate"
]
"""
The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
"""
display_name: str
"""
The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
"""
fixed_amount: NotRequired[
"SessionModifyParamsShippingOptionShippingRateDataFixedAmount"
]
"""
Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
"""
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`.
"""
tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]]
"""
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
"""
tax_code: NotRequired[str]
"""
A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
"""
type: NotRequired[Literal["fixed_amount"]]
"""
The type of calculation to use on the shipping rate.
"""
class SessionModifyParamsShippingOptionShippingRateDataDeliveryEstimate(
TypedDict,
):
maximum: NotRequired[
"SessionModifyParamsShippingOptionShippingRateDataDeliveryEstimateMaximum"
]
"""
The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
"""
minimum: NotRequired[
"SessionModifyParamsShippingOptionShippingRateDataDeliveryEstimateMinimum"
]
"""
The lower bound of the estimated range. If empty, represents no lower bound.
"""
class SessionModifyParamsShippingOptionShippingRateDataDeliveryEstimateMaximum(
TypedDict,
):
unit: Literal["business_day", "day", "hour", "month", "week"]
"""
A unit of time.
"""
value: int
"""
Must be greater than 0.
"""
class SessionModifyParamsShippingOptionShippingRateDataDeliveryEstimateMinimum(
TypedDict,
):
unit: Literal["business_day", "day", "hour", "month", "week"]
"""
A unit of time.
"""
value: int
"""
Must be greater than 0.
"""
class SessionModifyParamsShippingOptionShippingRateDataFixedAmount(TypedDict):
amount: int
"""
A non-negative integer in cents representing how much to charge.
"""
currency: str
"""
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
"""
currency_options: NotRequired[
Dict[
str,
"SessionModifyParamsShippingOptionShippingRateDataFixedAmountCurrencyOptions",
]
]
"""
Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
"""
class SessionModifyParamsShippingOptionShippingRateDataFixedAmountCurrencyOptions(
TypedDict,
):
amount: int
"""
A non-negative integer in cents representing how much to charge.
"""
tax_behavior: NotRequired[Literal["exclusive", "inclusive", "unspecified"]]
"""
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
"""
|
