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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._shipping_rate import ShippingRate
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class ShippingRateService(StripeService):
class CreateParams(TypedDict):
delivery_estimate: NotRequired[
"ShippingRateService.CreateParamsDeliveryEstimate"
]
"""
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.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
fixed_amount: NotRequired[
"ShippingRateService.CreateParamsFixedAmount"
]
"""
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 CreateParamsDeliveryEstimate(TypedDict):
maximum: NotRequired[
"ShippingRateService.CreateParamsDeliveryEstimateMaximum"
]
"""
The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
"""
minimum: NotRequired[
"ShippingRateService.CreateParamsDeliveryEstimateMinimum"
]
"""
The lower bound of the estimated range. If empty, represents no lower bound.
"""
class CreateParamsDeliveryEstimateMaximum(TypedDict):
unit: Literal["business_day", "day", "hour", "month", "week"]
"""
A unit of time.
"""
value: int
"""
Must be greater than 0.
"""
class CreateParamsDeliveryEstimateMinimum(TypedDict):
unit: Literal["business_day", "day", "hour", "month", "week"]
"""
A unit of time.
"""
value: int
"""
Must be greater than 0.
"""
class CreateParamsFixedAmount(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,
"ShippingRateService.CreateParamsFixedAmountCurrencyOptions",
]
]
"""
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 CreateParamsFixedAmountCurrencyOptions(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`.
"""
class ListParams(TypedDict):
active: NotRequired[bool]
"""
Only return shipping rates that are active or inactive.
"""
created: NotRequired["ShippingRateService.ListParamsCreated|int"]
"""
A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
"""
currency: NotRequired[str]
"""
Only return shipping rates for the given currency.
"""
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.
"""
class ListParamsCreated(TypedDict):
gt: NotRequired[int]
"""
Minimum value to filter by (exclusive)
"""
gte: NotRequired[int]
"""
Minimum value to filter by (inclusive)
"""
lt: NotRequired[int]
"""
Maximum value to filter by (exclusive)
"""
lte: NotRequired[int]
"""
Maximum value to filter by (inclusive)
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class UpdateParams(TypedDict):
active: NotRequired[bool]
"""
Whether the shipping rate can be used for new purchases. Defaults to `true`.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
fixed_amount: NotRequired[
"ShippingRateService.UpdateParamsFixedAmount"
]
"""
Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
"""
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`.
"""
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`.
"""
class UpdateParamsFixedAmount(TypedDict):
currency_options: NotRequired[
Dict[
str,
"ShippingRateService.UpdateParamsFixedAmountCurrencyOptions",
]
]
"""
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 UpdateParamsFixedAmountCurrencyOptions(TypedDict):
amount: NotRequired[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`.
"""
def list(
self,
params: "ShippingRateService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[ShippingRate]:
"""
Returns a list of your shipping rates.
"""
return cast(
ListObject[ShippingRate],
self._request(
"get",
"/v1/shipping_rates",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: "ShippingRateService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[ShippingRate]:
"""
Returns a list of your shipping rates.
"""
return cast(
ListObject[ShippingRate],
await self._request_async(
"get",
"/v1/shipping_rates",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "ShippingRateService.CreateParams",
options: RequestOptions = {},
) -> ShippingRate:
"""
Creates a new shipping rate object.
"""
return cast(
ShippingRate,
self._request(
"post",
"/v1/shipping_rates",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "ShippingRateService.CreateParams",
options: RequestOptions = {},
) -> ShippingRate:
"""
Creates a new shipping rate object.
"""
return cast(
ShippingRate,
await self._request_async(
"post",
"/v1/shipping_rates",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
shipping_rate_token: str,
params: "ShippingRateService.RetrieveParams" = {},
options: RequestOptions = {},
) -> ShippingRate:
"""
Returns the shipping rate object with the given ID.
"""
return cast(
ShippingRate,
self._request(
"get",
"/v1/shipping_rates/{shipping_rate_token}".format(
shipping_rate_token=sanitize_id(shipping_rate_token),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
shipping_rate_token: str,
params: "ShippingRateService.RetrieveParams" = {},
options: RequestOptions = {},
) -> ShippingRate:
"""
Returns the shipping rate object with the given ID.
"""
return cast(
ShippingRate,
await self._request_async(
"get",
"/v1/shipping_rates/{shipping_rate_token}".format(
shipping_rate_token=sanitize_id(shipping_rate_token),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
shipping_rate_token: str,
params: "ShippingRateService.UpdateParams" = {},
options: RequestOptions = {},
) -> ShippingRate:
"""
Updates an existing shipping rate object.
"""
return cast(
ShippingRate,
self._request(
"post",
"/v1/shipping_rates/{shipping_rate_token}".format(
shipping_rate_token=sanitize_id(shipping_rate_token),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
shipping_rate_token: str,
params: "ShippingRateService.UpdateParams" = {},
options: RequestOptions = {},
) -> ShippingRate:
"""
Updates an existing shipping rate object.
"""
return cast(
ShippingRate,
await self._request_async(
"post",
"/v1/shipping_rates/{shipping_rate_token}".format(
shipping_rate_token=sanitize_id(shipping_rate_token),
),
base_address="api",
params=params,
options=options,
),
)
|
