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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._expandable_field import ExpandableField
from stripe._stripe_object import StripeObject
from typing import ClassVar, List, Optional
from typing_extensions import Literal, TYPE_CHECKING
if TYPE_CHECKING:
from stripe._discount import Discount
from stripe._tax_rate import TaxRate
from stripe.billing._credit_balance_transaction import (
CreditBalanceTransaction,
)
class CreditNoteLineItem(StripeObject):
"""
The credit note line item object
"""
OBJECT_NAME: ClassVar[Literal["credit_note_line_item"]] = (
"credit_note_line_item"
)
class DiscountAmount(StripeObject):
amount: int
"""
The amount, in cents (or local equivalent), of the discount.
"""
discount: ExpandableField["Discount"]
"""
The discount that was applied to get this discount amount.
"""
class PretaxCreditAmount(StripeObject):
amount: int
"""
The amount, in cents (or local equivalent), of the pretax credit amount.
"""
credit_balance_transaction: Optional[
ExpandableField["CreditBalanceTransaction"]
]
"""
The credit balance transaction that was applied to get this pretax credit amount.
"""
discount: Optional[ExpandableField["Discount"]]
"""
The discount that was applied to get this pretax credit amount.
"""
type: Literal["credit_balance_transaction", "discount"]
"""
Type of the pretax credit amount referenced.
"""
class Tax(StripeObject):
class TaxRateDetails(StripeObject):
tax_rate: str
amount: int
"""
The amount of the tax, in cents (or local equivalent).
"""
tax_behavior: Literal["exclusive", "inclusive"]
"""
Whether this tax is inclusive or exclusive.
"""
tax_rate_details: Optional[TaxRateDetails]
"""
Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
"""
taxability_reason: Literal[
"customer_exempt",
"not_available",
"not_collecting",
"not_subject_to_tax",
"not_supported",
"portion_product_exempt",
"portion_reduced_rated",
"portion_standard_rated",
"product_exempt",
"product_exempt_holiday",
"proportionally_rated",
"reduced_rated",
"reverse_charge",
"standard_rated",
"taxable_basis_reduced",
"zero_rated",
]
"""
The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
"""
taxable_amount: Optional[int]
"""
The amount on which tax is calculated, in cents (or local equivalent).
"""
type: Literal["tax_rate_details"]
"""
The type of tax information.
"""
_inner_class_types = {"tax_rate_details": TaxRateDetails}
amount: int
"""
The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
"""
description: Optional[str]
"""
Description of the item being credited.
"""
discount_amount: int
"""
The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
"""
discount_amounts: List[DiscountAmount]
"""
The amount of discount calculated per discount for this line item
"""
id: str
"""
Unique identifier for the object.
"""
invoice_line_item: Optional[str]
"""
ID of the invoice line item being credited
"""
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["credit_note_line_item"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
pretax_credit_amounts: List[PretaxCreditAmount]
"""
The pretax credit amounts (ex: discount, credit grants, etc) for this line item.
"""
quantity: Optional[int]
"""
The number of units of product being credited.
"""
tax_rates: List["TaxRate"]
"""
The tax rates which apply to the line item.
"""
taxes: Optional[List[Tax]]
"""
The tax information of the line item.
"""
type: Literal["custom_line_item", "invoice_line_item"]
"""
The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.
"""
unit_amount: Optional[int]
"""
The cost of each unit of product being credited.
"""
unit_amount_decimal: Optional[str]
"""
Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
"""
_inner_class_types = {
"discount_amounts": DiscountAmount,
"pretax_credit_amounts": PretaxCreditAmount,
"taxes": Tax,
}
|
