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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._customer_balance_transaction import CustomerBalanceTransaction
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
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 CustomerBalanceTransactionService(StripeService):
class CreateParams(TypedDict):
amount: int
"""
The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.
"""
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). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.
"""
description: NotRequired[str]
"""
An arbitrary string attached to the object. Often useful for displaying to users.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
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`.
"""
class ListParams(TypedDict):
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 RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class UpdateParams(TypedDict):
description: NotRequired[str]
"""
An arbitrary string attached to the object. Often useful for displaying to users.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
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`.
"""
def list(
self,
customer: str,
params: "CustomerBalanceTransactionService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[CustomerBalanceTransaction]:
"""
Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
"""
return cast(
ListObject[CustomerBalanceTransaction],
self._request(
"get",
"/v1/customers/{customer}/balance_transactions".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
customer: str,
params: "CustomerBalanceTransactionService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[CustomerBalanceTransaction]:
"""
Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
"""
return cast(
ListObject[CustomerBalanceTransaction],
await self._request_async(
"get",
"/v1/customers/{customer}/balance_transactions".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def create(
self,
customer: str,
params: "CustomerBalanceTransactionService.CreateParams",
options: RequestOptions = {},
) -> CustomerBalanceTransaction:
"""
Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance).
"""
return cast(
CustomerBalanceTransaction,
self._request(
"post",
"/v1/customers/{customer}/balance_transactions".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
customer: str,
params: "CustomerBalanceTransactionService.CreateParams",
options: RequestOptions = {},
) -> CustomerBalanceTransaction:
"""
Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance).
"""
return cast(
CustomerBalanceTransaction,
await self._request_async(
"post",
"/v1/customers/{customer}/balance_transactions".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
customer: str,
transaction: str,
params: "CustomerBalanceTransactionService.RetrieveParams" = {},
options: RequestOptions = {},
) -> CustomerBalanceTransaction:
"""
Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
"""
return cast(
CustomerBalanceTransaction,
self._request(
"get",
"/v1/customers/{customer}/balance_transactions/{transaction}".format(
customer=sanitize_id(customer),
transaction=sanitize_id(transaction),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
customer: str,
transaction: str,
params: "CustomerBalanceTransactionService.RetrieveParams" = {},
options: RequestOptions = {},
) -> CustomerBalanceTransaction:
"""
Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
"""
return cast(
CustomerBalanceTransaction,
await self._request_async(
"get",
"/v1/customers/{customer}/balance_transactions/{transaction}".format(
customer=sanitize_id(customer),
transaction=sanitize_id(transaction),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
customer: str,
transaction: str,
params: "CustomerBalanceTransactionService.UpdateParams" = {},
options: RequestOptions = {},
) -> CustomerBalanceTransaction:
"""
Most credit balance transaction fields are immutable, but you may update its description and metadata.
"""
return cast(
CustomerBalanceTransaction,
self._request(
"post",
"/v1/customers/{customer}/balance_transactions/{transaction}".format(
customer=sanitize_id(customer),
transaction=sanitize_id(transaction),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
customer: str,
transaction: str,
params: "CustomerBalanceTransactionService.UpdateParams" = {},
options: RequestOptions = {},
) -> CustomerBalanceTransaction:
"""
Most credit balance transaction fields are immutable, but you may update its description and metadata.
"""
return cast(
CustomerBalanceTransaction,
await self._request_async(
"post",
"/v1/customers/{customer}/balance_transactions/{transaction}".format(
customer=sanitize_id(customer),
transaction=sanitize_id(transaction),
),
base_address="api",
params=params,
options=options,
),
)
|
