stripe_shared/
discount.rs

1/// A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
2/// It contains information about when the discount began, when it will end, and what it is applied to.
3///
4/// Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts).
5///
6/// For more details see <<https://stripe.com/docs/api/discounts/object>>.
7#[derive(Clone, Debug)]
8#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
9pub struct Discount {
10    /// The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode.
11    /// Will not be present for subscription mode.
12    pub checkout_session: Option<String>,
13    /// The ID of the customer associated with this discount.
14    pub customer: Option<stripe_types::Expandable<stripe_shared::Customer>>,
15    /// The ID of the account representing the customer associated with this discount.
16    pub customer_account: Option<String>,
17    /// If the coupon has a duration of `repeating`, the date that this discount will end.
18    /// If the coupon has a duration of `once` or `forever`, this attribute will be null.
19    pub end: Option<stripe_types::Timestamp>,
20    /// The ID of the discount object.
21    /// Discounts cannot be fetched by ID.
22    /// Use `expand[]=discounts` in API calls to expand discount IDs in an array.
23    pub id: stripe_shared::DiscountId,
24    /// The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
25    pub invoice: Option<String>,
26    /// 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.
27    pub invoice_item: Option<String>,
28    /// The promotion code applied to create this discount.
29    pub promotion_code: Option<stripe_types::Expandable<stripe_shared::PromotionCode>>,
30    pub source: stripe_shared::DiscountSource,
31    /// Date that the coupon was applied.
32    pub start: stripe_types::Timestamp,
33    /// The subscription that this coupon is applied to, if it is applied to a particular subscription.
34    pub subscription: Option<String>,
35    /// The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
36    pub subscription_item: Option<String>,
37}
38#[doc(hidden)]
39pub struct DiscountBuilder {
40    checkout_session: Option<Option<String>>,
41    customer: Option<Option<stripe_types::Expandable<stripe_shared::Customer>>>,
42    customer_account: Option<Option<String>>,
43    end: Option<Option<stripe_types::Timestamp>>,
44    id: Option<stripe_shared::DiscountId>,
45    invoice: Option<Option<String>>,
46    invoice_item: Option<Option<String>>,
47    promotion_code: Option<Option<stripe_types::Expandable<stripe_shared::PromotionCode>>>,
48    source: Option<stripe_shared::DiscountSource>,
49    start: Option<stripe_types::Timestamp>,
50    subscription: Option<Option<String>>,
51    subscription_item: Option<Option<String>>,
52}
53
54#[allow(
55    unused_variables,
56    irrefutable_let_patterns,
57    clippy::let_unit_value,
58    clippy::match_single_binding,
59    clippy::single_match
60)]
61const _: () = {
62    use miniserde::de::{Map, Visitor};
63    use miniserde::json::Value;
64    use miniserde::{Deserialize, Result, make_place};
65    use stripe_types::miniserde_helpers::FromValueOpt;
66    use stripe_types::{MapBuilder, ObjectDeser};
67
68    make_place!(Place);
69
70    impl Deserialize for Discount {
71        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
72            Place::new(out)
73        }
74    }
75
76    struct Builder<'a> {
77        out: &'a mut Option<Discount>,
78        builder: DiscountBuilder,
79    }
80
81    impl Visitor for Place<Discount> {
82        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
83            Ok(Box::new(Builder { out: &mut self.out, builder: DiscountBuilder::deser_default() }))
84        }
85    }
86
87    impl MapBuilder for DiscountBuilder {
88        type Out = Discount;
89        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
90            Ok(match k {
91                "checkout_session" => Deserialize::begin(&mut self.checkout_session),
92                "customer" => Deserialize::begin(&mut self.customer),
93                "customer_account" => Deserialize::begin(&mut self.customer_account),
94                "end" => Deserialize::begin(&mut self.end),
95                "id" => Deserialize::begin(&mut self.id),
96                "invoice" => Deserialize::begin(&mut self.invoice),
97                "invoice_item" => Deserialize::begin(&mut self.invoice_item),
98                "promotion_code" => Deserialize::begin(&mut self.promotion_code),
99                "source" => Deserialize::begin(&mut self.source),
100                "start" => Deserialize::begin(&mut self.start),
101                "subscription" => Deserialize::begin(&mut self.subscription),
102                "subscription_item" => Deserialize::begin(&mut self.subscription_item),
103                _ => <dyn Visitor>::ignore(),
104            })
105        }
106
107        fn deser_default() -> Self {
108            Self {
109                checkout_session: Deserialize::default(),
110                customer: Deserialize::default(),
111                customer_account: Deserialize::default(),
112                end: Deserialize::default(),
113                id: Deserialize::default(),
114                invoice: Deserialize::default(),
115                invoice_item: Deserialize::default(),
116                promotion_code: Deserialize::default(),
117                source: Deserialize::default(),
118                start: Deserialize::default(),
119                subscription: Deserialize::default(),
120                subscription_item: Deserialize::default(),
121            }
122        }
123
124        fn take_out(&mut self) -> Option<Self::Out> {
125            let (
126                Some(checkout_session),
127                Some(customer),
128                Some(customer_account),
129                Some(end),
130                Some(id),
131                Some(invoice),
132                Some(invoice_item),
133                Some(promotion_code),
134                Some(source),
135                Some(start),
136                Some(subscription),
137                Some(subscription_item),
138            ) = (
139                self.checkout_session.take(),
140                self.customer.take(),
141                self.customer_account.take(),
142                self.end,
143                self.id.take(),
144                self.invoice.take(),
145                self.invoice_item.take(),
146                self.promotion_code.take(),
147                self.source.take(),
148                self.start,
149                self.subscription.take(),
150                self.subscription_item.take(),
151            )
152            else {
153                return None;
154            };
155            Some(Self::Out {
156                checkout_session,
157                customer,
158                customer_account,
159                end,
160                id,
161                invoice,
162                invoice_item,
163                promotion_code,
164                source,
165                start,
166                subscription,
167                subscription_item,
168            })
169        }
170    }
171
172    impl Map for Builder<'_> {
173        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
174            self.builder.key(k)
175        }
176
177        fn finish(&mut self) -> Result<()> {
178            *self.out = self.builder.take_out();
179            Ok(())
180        }
181    }
182
183    impl ObjectDeser for Discount {
184        type Builder = DiscountBuilder;
185    }
186
187    impl FromValueOpt for Discount {
188        fn from_value(v: Value) -> Option<Self> {
189            let Value::Object(obj) = v else {
190                return None;
191            };
192            let mut b = DiscountBuilder::deser_default();
193            for (k, v) in obj {
194                match k.as_str() {
195                    "checkout_session" => b.checkout_session = FromValueOpt::from_value(v),
196                    "customer" => b.customer = FromValueOpt::from_value(v),
197                    "customer_account" => b.customer_account = FromValueOpt::from_value(v),
198                    "end" => b.end = FromValueOpt::from_value(v),
199                    "id" => b.id = FromValueOpt::from_value(v),
200                    "invoice" => b.invoice = FromValueOpt::from_value(v),
201                    "invoice_item" => b.invoice_item = FromValueOpt::from_value(v),
202                    "promotion_code" => b.promotion_code = FromValueOpt::from_value(v),
203                    "source" => b.source = FromValueOpt::from_value(v),
204                    "start" => b.start = FromValueOpt::from_value(v),
205                    "subscription" => b.subscription = FromValueOpt::from_value(v),
206                    "subscription_item" => b.subscription_item = FromValueOpt::from_value(v),
207                    _ => {}
208                }
209            }
210            b.take_out()
211        }
212    }
213};
214#[cfg(feature = "serialize")]
215impl serde::Serialize for Discount {
216    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
217        use serde::ser::SerializeStruct;
218        let mut s = s.serialize_struct("Discount", 13)?;
219        s.serialize_field("checkout_session", &self.checkout_session)?;
220        s.serialize_field("customer", &self.customer)?;
221        s.serialize_field("customer_account", &self.customer_account)?;
222        s.serialize_field("end", &self.end)?;
223        s.serialize_field("id", &self.id)?;
224        s.serialize_field("invoice", &self.invoice)?;
225        s.serialize_field("invoice_item", &self.invoice_item)?;
226        s.serialize_field("promotion_code", &self.promotion_code)?;
227        s.serialize_field("source", &self.source)?;
228        s.serialize_field("start", &self.start)?;
229        s.serialize_field("subscription", &self.subscription)?;
230        s.serialize_field("subscription_item", &self.subscription_item)?;
231
232        s.serialize_field("object", "discount")?;
233        s.end()
234    }
235}
236impl stripe_types::Object for Discount {
237    type Id = stripe_shared::DiscountId;
238    fn id(&self) -> &Self::Id {
239        &self.id
240    }
241
242    fn into_id(self) -> Self::Id {
243        self.id
244    }
245}
246stripe_types::def_id!(DiscountId);
stripe_shared/discount.rs

stripe_shared/
discount.rs
