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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from typing import ClassVar
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params._tax_code_list_params import TaxCodeListParams
from stripe.params._tax_code_retrieve_params import TaxCodeRetrieveParams
class TaxCode(ListableAPIResource["TaxCode"]):
"""
[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
"""
OBJECT_NAME: ClassVar[Literal["tax_code"]] = "tax_code"
description: str
"""
A detailed description of which types of products the tax code represents.
"""
id: str
"""
Unique identifier for the object.
"""
name: str
"""
A short name for the tax code.
"""
object: Literal["tax_code"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
@classmethod
def list(
cls, **params: Unpack["TaxCodeListParams"]
) -> ListObject["TaxCode"]:
"""
A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["TaxCodeListParams"]
) -> ListObject["TaxCode"]:
"""
A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def retrieve(
cls, id: str, **params: Unpack["TaxCodeRetrieveParams"]
) -> "TaxCode":
"""
Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["TaxCodeRetrieveParams"]
) -> "TaxCode":
"""
Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
|
