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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_object import StripeObject
from typing import ClassVar, Dict, List, Optional
from typing_extensions import Literal, TYPE_CHECKING
if TYPE_CHECKING:
from stripe._discount import Discount as DiscountResource
from stripe._price import Price
from stripe._tax_rate import TaxRate
class LineItem(StripeObject):
"""
A line item.
"""
OBJECT_NAME: ClassVar[Literal["item"]] = "item"
class AdjustableQuantity(StripeObject):
enabled: bool
maximum: Optional[int]
minimum: Optional[int]
class Discount(StripeObject):
amount: int
"""
The amount discounted.
"""
discount: "DiscountResource"
"""
A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
It contains information about when the discount began, when it will end, and what it is applied to.
Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
"""
class Tax(StripeObject):
amount: int
"""
Amount of tax applied for this rate.
"""
rate: "TaxRate"
"""
Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
"""
taxability_reason: Optional[
Literal[
"customer_exempt",
"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).
"""
adjustable_quantity: Optional[AdjustableQuantity]
amount_discount: int
"""
Total discount amount applied. If no discounts were applied, defaults to 0.
"""
amount_subtotal: int
"""
Total before any discounts or taxes are applied.
"""
amount_tax: int
"""
Total tax amount applied. If no tax was applied, defaults to 0.
"""
amount_total: int
"""
Total after discounts and taxes.
"""
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).
"""
description: Optional[str]
"""
An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
"""
discounts: Optional[List[Discount]]
"""
The discounts applied to the line item.
"""
id: str
"""
Unique identifier for the object.
"""
metadata: Optional[Dict[str, str]]
"""
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
"""
object: Literal["item"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
price: Optional["Price"]
"""
The price used to generate the line item.
"""
quantity: Optional[int]
"""
The quantity of products being purchased.
"""
taxes: Optional[List[Tax]]
"""
The taxes applied to the line item.
"""
_inner_class_types = {
"adjustable_quantity": AdjustableQuantity,
"discounts": Discount,
"taxes": Tax,
}
|
