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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._singleton_api_resource import SingletonAPIResource
from stripe._stripe_object import StripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from typing import ClassVar, List, Optional, cast
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.tax._settings_modify_params import SettingsModifyParams
from stripe.params.tax._settings_retrieve_params import (
SettingsRetrieveParams,
)
class Settings(
SingletonAPIResource["Settings"],
UpdateableAPIResource["Settings"],
):
"""
You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.
Related guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api)
"""
OBJECT_NAME: ClassVar[Literal["tax.settings"]] = "tax.settings"
class Defaults(StripeObject):
provider: Literal["anrok", "avalara", "sphere", "stripe"]
"""
The tax calculation provider this account uses. Defaults to `stripe` when not using a [third-party provider](https://docs.stripe.com/tax/third-party-apps).
"""
tax_behavior: Optional[
Literal["exclusive", "inclusive", "inferred_by_currency"]
]
"""
Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior.
"""
tax_code: Optional[str]
"""
Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices.
"""
class HeadOffice(StripeObject):
class Address(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1, such as the street, PO Box, or company name.
"""
line2: Optional[str]
"""
Address line 2, such as the apartment, suite, unit, or building.
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
"""
address: Address
_inner_class_types = {"address": Address}
class StatusDetails(StripeObject):
class Active(StripeObject):
pass
class Pending(StripeObject):
missing_fields: Optional[List[str]]
"""
The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.
"""
active: Optional[Active]
pending: Optional[Pending]
_inner_class_types = {"active": Active, "pending": Pending}
defaults: Defaults
head_office: Optional[HeadOffice]
"""
The place where your business is located.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
object: Literal["tax.settings"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
status: Literal["active", "pending"]
"""
The status of the Tax `Settings`.
"""
status_details: StatusDetails
@classmethod
def modify(cls, **params: Unpack["SettingsModifyParams"]) -> "Settings":
"""
Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
"""
return cast(
"Settings",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def modify_async(
cls, **params: Unpack["SettingsModifyParams"]
) -> "Settings":
"""
Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
"""
return cast(
"Settings",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def retrieve(
cls, **params: Unpack["SettingsRetrieveParams"]
) -> "Settings":
"""
Retrieves Tax Settings for a merchant.
"""
instance = cls(None, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, **params: Unpack["SettingsRetrieveParams"]
) -> "Settings":
"""
Retrieves Tax Settings for a merchant.
"""
instance = cls(None, **params)
await instance.refresh_async()
return instance
@classmethod
def class_url(cls):
return "/v1/tax/settings"
_inner_class_types = {
"defaults": Defaults,
"head_office": HeadOffice,
"status_details": StatusDetails,
}
|
