stripe_shared/
discount.rs

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

stripe_shared/
discount.rs
