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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._credit_note_line_item import CreditNoteLineItem
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class CreditNotePreviewLinesService(StripeService):
class ListParams(TypedDict):
amount: NotRequired[int]
"""
The integer amount in cents (or local equivalent) representing the total amount of the credit note.
"""
credit_amount: NotRequired[int]
"""
The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
"""
effective_at: NotRequired[int]
"""
The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
"""
email_type: NotRequired[Literal["credit_note", "none"]]
"""
Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
"""
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.
"""
invoice: str
"""
ID of the invoice.
"""
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.
"""
lines: NotRequired[
List["CreditNotePreviewLinesService.ListParamsLine"]
]
"""
Line items that make up the credit note.
"""
memo: NotRequired[str]
"""
The credit note's memo appears on the credit note PDF.
"""
metadata: NotRequired[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`.
"""
out_of_band_amount: NotRequired[int]
"""
The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
"""
reason: NotRequired[
Literal[
"duplicate",
"fraudulent",
"order_change",
"product_unsatisfactory",
]
]
"""
Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
"""
refund_amount: NotRequired[int]
"""
The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
"""
refunds: NotRequired[
List["CreditNotePreviewLinesService.ListParamsRefund"]
]
"""
Refunds to link to this credit note.
"""
shipping_cost: NotRequired[
"CreditNotePreviewLinesService.ListParamsShippingCost"
]
"""
When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
"""
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 ListParamsLine(TypedDict):
amount: NotRequired[int]
"""
The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive
"""
description: NotRequired[str]
"""
The description of the credit note line item. Only valid when the `type` is `custom_line_item`.
"""
invoice_line_item: NotRequired[str]
"""
The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.
"""
quantity: NotRequired[int]
"""
The line item quantity to credit.
"""
tax_amounts: NotRequired[
"Literal['']|List[CreditNotePreviewLinesService.ListParamsLineTaxAmount]"
]
"""
A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.
"""
tax_rates: NotRequired["Literal['']|List[str]"]
"""
The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.
"""
type: Literal["custom_line_item", "invoice_line_item"]
"""
Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`
"""
unit_amount: NotRequired[int]
"""
The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
"""
unit_amount_decimal: NotRequired[str]
"""
Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
"""
class ListParamsLineTaxAmount(TypedDict):
amount: int
"""
The amount, in cents (or local equivalent), of the tax.
"""
tax_rate: str
"""
The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.
"""
taxable_amount: int
"""
The amount on which tax is calculated, in cents (or local equivalent).
"""
class ListParamsRefund(TypedDict):
amount_refunded: NotRequired[int]
"""
Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
"""
refund: NotRequired[str]
"""
ID of an existing refund to link this credit note to.
"""
class ListParamsShippingCost(TypedDict):
shipping_rate: NotRequired[str]
"""
The ID of the shipping rate to use for this order.
"""
def list(
self,
params: "CreditNotePreviewLinesService.ListParams",
options: RequestOptions = {},
) -> ListObject[CreditNoteLineItem]:
"""
When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
"""
return cast(
ListObject[CreditNoteLineItem],
self._request(
"get",
"/v1/credit_notes/preview/lines",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: "CreditNotePreviewLinesService.ListParams",
options: RequestOptions = {},
) -> ListObject[CreditNoteLineItem]:
"""
When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
"""
return cast(
ListObject[CreditNoteLineItem],
await self._request_async(
"get",
"/v1/credit_notes/preview/lines",
base_address="api",
params=params,
options=options,
),
)
|
