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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import Dict, List
from typing_extensions import Literal, NotRequired, TypedDict
class CustomerUpdateParams(TypedDict):
address: NotRequired["Literal['']|CustomerUpdateParamsAddress"]
"""
The customer's address.
"""
balance: NotRequired[int]
"""
An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
"""
business_name: NotRequired["Literal['']|str"]
"""
The customer's business name. This may be up to *150 characters*.
"""
cash_balance: NotRequired["CustomerUpdateParamsCashBalance"]
"""
Balance information and default balance settings for this customer.
"""
default_source: NotRequired[str]
"""
If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.
Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.
If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.
"""
description: NotRequired[str]
"""
An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
"""
email: NotRequired[str]
"""
Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
individual_name: NotRequired["Literal['']|str"]
"""
The customer's full name. This may be up to *150 characters*.
"""
invoice_prefix: NotRequired[str]
"""
The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
"""
invoice_settings: NotRequired["CustomerUpdateParamsInvoiceSettings"]
"""
Default invoice settings for this customer.
"""
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`.
"""
name: NotRequired[str]
"""
The customer's full name or business name.
"""
next_invoice_sequence: NotRequired[int]
"""
The sequence to be used on the customer's next invoice. Defaults to 1.
"""
phone: NotRequired[str]
"""
The customer's phone number.
"""
preferred_locales: NotRequired[List[str]]
"""
Customer's preferred languages, ordered by preference.
"""
shipping: NotRequired["Literal['']|CustomerUpdateParamsShipping"]
"""
The customer's shipping information. Appears on invoices emailed to this customer.
"""
source: NotRequired[str]
tax: NotRequired["CustomerUpdateParamsTax"]
"""
Tax details about the customer.
"""
tax_exempt: NotRequired["Literal['']|Literal['exempt', 'none', 'reverse']"]
"""
The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
"""
validate: NotRequired[bool]
class CustomerUpdateParamsAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[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 CustomerUpdateParamsCashBalance(TypedDict):
settings: NotRequired["CustomerUpdateParamsCashBalanceSettings"]
"""
Settings controlling the behavior of the customer's cash balance,
such as reconciliation of funds received.
"""
class CustomerUpdateParamsCashBalanceSettings(TypedDict):
reconciliation_mode: NotRequired[
Literal["automatic", "manual", "merchant_default"]
]
"""
Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
"""
class CustomerUpdateParamsInvoiceSettings(TypedDict):
custom_fields: NotRequired[
"Literal['']|List[CustomerUpdateParamsInvoiceSettingsCustomField]"
]
"""
The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.
"""
default_payment_method: NotRequired[str]
"""
ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
"""
footer: NotRequired[str]
"""
Default footer to be displayed on invoices for this customer.
"""
rendering_options: NotRequired[
"Literal['']|CustomerUpdateParamsInvoiceSettingsRenderingOptions"
]
"""
Default options for invoice PDF rendering for this customer.
"""
class CustomerUpdateParamsInvoiceSettingsCustomField(TypedDict):
name: str
"""
The name of the custom field. This may be up to 40 characters.
"""
value: str
"""
The value of the custom field. This may be up to 140 characters.
"""
class CustomerUpdateParamsInvoiceSettingsRenderingOptions(TypedDict):
amount_tax_display: NotRequired[
"Literal['']|Literal['exclude_tax', 'include_inclusive_tax']"
]
"""
How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
"""
template: NotRequired[str]
"""
ID of the invoice rendering template to use for future invoices.
"""
class CustomerUpdateParamsShipping(TypedDict):
address: "CustomerUpdateParamsShippingAddress"
"""
Customer shipping address.
"""
name: str
"""
Customer name.
"""
phone: NotRequired[str]
"""
Customer phone (including extension).
"""
class CustomerUpdateParamsShippingAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[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 CustomerUpdateParamsTax(TypedDict):
ip_address: NotRequired["Literal['']|str"]
"""
A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.
"""
validate_location: NotRequired[Literal["auto", "deferred", "immediately"]]
"""
A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.
"""
|
