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
|
# -*- 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, Optional
from typing_extensions import Literal, TYPE_CHECKING
if TYPE_CHECKING:
from stripe._coupon import Coupon
from stripe._customer import Customer
from stripe._promotion_code import PromotionCode
class Discount(StripeObject):
"""
A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#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://stripe.com/docs/billing/subscriptions/discounts)
"""
OBJECT_NAME: ClassVar[Literal["discount"]] = "discount"
checkout_session: Optional[str]
"""
The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
"""
coupon: "Coupon"
"""
A coupon contains information about a percent-off or amount-off discount you
might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
[checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
"""
customer: Optional[ExpandableField["Customer"]]
"""
The ID of the customer associated with this discount.
"""
end: Optional[int]
"""
If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.
"""
id: str
"""
The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.
"""
invoice: Optional[str]
"""
The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
"""
invoice_item: Optional[str]
"""
The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
"""
object: Literal["discount"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
promotion_code: Optional[ExpandableField["PromotionCode"]]
"""
The promotion code applied to create this discount.
"""
start: int
"""
Date that the coupon was applied.
"""
subscription: Optional[str]
"""
The subscription that this coupon is applied to, if it is applied to a particular subscription.
"""
subscription_item: Optional[str]
"""
The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
"""
deleted: Optional[Literal[True]]
"""
Always true for a deleted object
"""
|
