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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._credit_note import CreditNote
from stripe._credit_note_line_item_service import CreditNoteLineItemService
from stripe._credit_note_preview_lines_service import (
CreditNotePreviewLinesService,
)
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.params._credit_note_create_params import CreditNoteCreateParams
from stripe.params._credit_note_list_params import CreditNoteListParams
from stripe.params._credit_note_preview_params import (
CreditNotePreviewParams,
)
from stripe.params._credit_note_retrieve_params import (
CreditNoteRetrieveParams,
)
from stripe.params._credit_note_update_params import CreditNoteUpdateParams
from stripe.params._credit_note_void_credit_note_params import (
CreditNoteVoidCreditNoteParams,
)
_subservices = {
"line_items": [
"stripe._credit_note_line_item_service",
"CreditNoteLineItemService",
],
"preview_lines": [
"stripe._credit_note_preview_lines_service",
"CreditNotePreviewLinesService",
],
}
class CreditNoteService(StripeService):
line_items: "CreditNoteLineItemService"
preview_lines: "CreditNotePreviewLinesService"
def __init__(self, requestor):
super().__init__(requestor)
def __getattr__(self, name):
try:
import_from, service = _subservices[name]
service_class = getattr(
import_module(import_from),
service,
)
setattr(
self,
name,
service_class(self._requestor),
)
return getattr(self, name)
except KeyError:
raise AttributeError()
def list(
self,
params: Optional["CreditNoteListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[CreditNote]":
"""
Returns a list of credit notes.
"""
return cast(
"ListObject[CreditNote]",
self._request(
"get",
"/v1/credit_notes",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["CreditNoteListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[CreditNote]":
"""
Returns a list of credit notes.
"""
return cast(
"ListObject[CreditNote]",
await self._request_async(
"get",
"/v1/credit_notes",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "CreditNoteCreateParams",
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
"""
return cast(
"CreditNote",
self._request(
"post",
"/v1/credit_notes",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "CreditNoteCreateParams",
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
"""
return cast(
"CreditNote",
await self._request_async(
"post",
"/v1/credit_notes",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
id: str,
params: Optional["CreditNoteRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Retrieves the credit note object with the given identifier.
"""
return cast(
"CreditNote",
self._request(
"get",
"/v1/credit_notes/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
id: str,
params: Optional["CreditNoteRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Retrieves the credit note object with the given identifier.
"""
return cast(
"CreditNote",
await self._request_async(
"get",
"/v1/credit_notes/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
id: str,
params: Optional["CreditNoteUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Updates an existing credit note.
"""
return cast(
"CreditNote",
self._request(
"post",
"/v1/credit_notes/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
id: str,
params: Optional["CreditNoteUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Updates an existing credit note.
"""
return cast(
"CreditNote",
await self._request_async(
"post",
"/v1/credit_notes/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
def preview(
self,
params: "CreditNotePreviewParams",
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Get a preview of a credit note without creating it.
"""
return cast(
"CreditNote",
self._request(
"get",
"/v1/credit_notes/preview",
base_address="api",
params=params,
options=options,
),
)
async def preview_async(
self,
params: "CreditNotePreviewParams",
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Get a preview of a credit note without creating it.
"""
return cast(
"CreditNote",
await self._request_async(
"get",
"/v1/credit_notes/preview",
base_address="api",
params=params,
options=options,
),
)
def void_credit_note(
self,
id: str,
params: Optional["CreditNoteVoidCreditNoteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
"""
return cast(
"CreditNote",
self._request(
"post",
"/v1/credit_notes/{id}/void".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def void_credit_note_async(
self,
id: str,
params: Optional["CreditNoteVoidCreditNoteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "CreditNote":
"""
Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
"""
return cast(
"CreditNote",
await self._request_async(
"post",
"/v1/credit_notes/{id}/void".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
|
