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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._tax_rate import TaxRate
from stripe._util import sanitize_id
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class TaxRateService(StripeService):
class CreateParams(TypedDict):
active: NotRequired[bool]
"""
Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
description: NotRequired[str]
"""
An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
"""
display_name: str
"""
The display name of the tax rate, which will be shown to users.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
inclusive: bool
"""
This specifies if the tax rate is inclusive or exclusive.
"""
jurisdiction: NotRequired[str]
"""
The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.
"""
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`.
"""
percentage: float
"""
This represents the tax rate percent out of 100.
"""
state: NotRequired[str]
"""
[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
"""
tax_type: NotRequired[
Literal[
"amusement_tax",
"communications_tax",
"gst",
"hst",
"igst",
"jct",
"lease_tax",
"pst",
"qst",
"retail_delivery_fee",
"rst",
"sales_tax",
"service_tax",
"vat",
]
]
"""
The high-level tax type, such as `vat` or `sales_tax`.
"""
class ListParams(TypedDict):
active: NotRequired[bool]
"""
Optional flag to filter by tax rates that are either active or inactive (archived).
"""
created: NotRequired["TaxRateService.ListParamsCreated|int"]
"""
Optional range for filtering created date.
"""
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.
"""
inclusive: NotRequired[bool]
"""
Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).
"""
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]
"""
Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
description: NotRequired[str]
"""
An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
"""
display_name: NotRequired[str]
"""
The display name of the tax rate, which will be shown to users.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
jurisdiction: NotRequired[str]
"""
The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.
"""
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`.
"""
state: NotRequired[str]
"""
[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
"""
tax_type: NotRequired[
Literal[
"amusement_tax",
"communications_tax",
"gst",
"hst",
"igst",
"jct",
"lease_tax",
"pst",
"qst",
"retail_delivery_fee",
"rst",
"sales_tax",
"service_tax",
"vat",
]
]
"""
The high-level tax type, such as `vat` or `sales_tax`.
"""
def list(
self,
params: "TaxRateService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[TaxRate]:
"""
Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
"""
return cast(
ListObject[TaxRate],
self._request(
"get",
"/v1/tax_rates",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: "TaxRateService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[TaxRate]:
"""
Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
"""
return cast(
ListObject[TaxRate],
await self._request_async(
"get",
"/v1/tax_rates",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "TaxRateService.CreateParams",
options: RequestOptions = {},
) -> TaxRate:
"""
Creates a new tax rate.
"""
return cast(
TaxRate,
self._request(
"post",
"/v1/tax_rates",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "TaxRateService.CreateParams",
options: RequestOptions = {},
) -> TaxRate:
"""
Creates a new tax rate.
"""
return cast(
TaxRate,
await self._request_async(
"post",
"/v1/tax_rates",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
tax_rate: str,
params: "TaxRateService.RetrieveParams" = {},
options: RequestOptions = {},
) -> TaxRate:
"""
Retrieves a tax rate with the given ID
"""
return cast(
TaxRate,
self._request(
"get",
"/v1/tax_rates/{tax_rate}".format(
tax_rate=sanitize_id(tax_rate),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
tax_rate: str,
params: "TaxRateService.RetrieveParams" = {},
options: RequestOptions = {},
) -> TaxRate:
"""
Retrieves a tax rate with the given ID
"""
return cast(
TaxRate,
await self._request_async(
"get",
"/v1/tax_rates/{tax_rate}".format(
tax_rate=sanitize_id(tax_rate),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
tax_rate: str,
params: "TaxRateService.UpdateParams" = {},
options: RequestOptions = {},
) -> TaxRate:
"""
Updates an existing tax rate.
"""
return cast(
TaxRate,
self._request(
"post",
"/v1/tax_rates/{tax_rate}".format(
tax_rate=sanitize_id(tax_rate),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
tax_rate: str,
params: "TaxRateService.UpdateParams" = {},
options: RequestOptions = {},
) -> TaxRate:
"""
Updates an existing tax rate.
"""
return cast(
TaxRate,
await self._request_async(
"post",
"/v1/tax_rates/{tax_rate}".format(
tax_rate=sanitize_id(tax_rate),
),
base_address="api",
params=params,
options=options,
),
)
|
